2 * This file is part of the libserialport project.
4 * Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as
8 * published by the Free Software Foundation, either version 3 of the
9 * License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 * @mainpage libserialport API
27 * libserialport is a minimal library written in C that is intended to take
28 * care of the OS-specific details when writing software that uses serial ports.
30 * By writing your serial code to use libserialport, you enable it to work
31 * transparently on any platform supported by the library.
33 * The operations that are supported are:
35 * - @ref Enumeration (obtaining a list of serial ports on the system)
37 * - @ref Configuration (baud rate, parity, etc.)
41 * libserialport is an open source project released under the LGPL3+ license.
46 * The API is simple, and designed to be a minimal wrapper around the serial
47 * port support in each OS.
49 * Most functions take a pointer to a struct sp_port, which represents a serial
50 * port. These structures are always allocated and freed by the library, using
51 * the functions in the @ref Enumeration "Enumeration" section.
53 * All functions can return only three possible error values. @ref SP_ERR_ARG
54 * indicates the function was called with invalid arguments. @ref SP_ERR_FAIL
55 * indicates that the OS reported a failure. @ref SP_ERR_MEM indicates that a
56 * memory allocation failed. All of these error values are negative.
58 * When @ref SP_ERR_FAIL is returned, an error code or string description of
59 * the error can be obtained by calling sp_last_error_code() or
60 * sp_last_error_message(). The error code or message is that provided by the
61 * OS; libserialport does not define any error codes or messages of its own.
63 * Function calls that succeed return @ref SP_OK, which is equal to zero,
64 * or where otherwise documented a positive value.
67 #ifndef LIBSERIALPORT_H
68 #define LIBSERIALPORT_H
79 /* Package version macros (e.g. for conditional compilation). */
80 #define SP_PACKAGE_VERSION_MAJOR @SP_PACKAGE_VERSION_MAJOR@
81 #define SP_PACKAGE_VERSION_MINOR @SP_PACKAGE_VERSION_MINOR@
82 #define SP_PACKAGE_VERSION_STRING "@SP_PACKAGE_VERSION@"
84 /* Library/libtool version macros (e.g. for conditional compilation). */
85 #define SP_LIB_VERSION_CURRENT @SP_LIB_VERSION_CURRENT@
86 #define SP_LIB_VERSION_REVISION @SP_LIB_VERSION_REVISION@
87 #define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@
88 #define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@"
92 /** Operation completed successfully. */
94 /** Invalid arguments were passed to the function. */
96 /** A system error occured while executing the operation. */
98 /** A memory allocation failed while executing the operation. */
102 /** Port access modes. */
104 /** Open port for read access. */
106 /** Open port for write access. */
108 /** Open port in non-blocking mode. */
109 SP_MODE_NONBLOCK = 4,
112 /** Parity settings. */
114 /** Special value to indicate setting should be left alone. */
115 SP_PARITY_INVALID = -1,
124 /** RTS pin behaviour. */
126 /** Special value to indicate setting should be left alone. */
132 /** RTS used for flow control. */
133 SP_RTS_FLOW_CONTROL = 2,
136 /** CTS pin behaviour. */
138 /** Special value to indicate setting should be left alone. */
142 /** CTS used for flow control. */
143 SP_CTS_FLOW_CONTROL = 1,
146 /** DTR pin behaviour. */
148 /** Special value to indicate setting should be left alone. */
154 /** DTR used for flow control. */
155 SP_DTR_FLOW_CONTROL = 2,
158 /** DSR pin behaviour. */
160 /** Special value to indicate setting should be left alone. */
164 /** DSR used for flow control. */
165 SP_DSR_FLOW_CONTROL = 1,
168 /** XON/XOFF flow control behaviour. */
170 /** Special value to indicate setting should be left alone. */
171 SP_XONXOFF_INVALID = -1,
172 /** XON/XOFF disabled. */
173 SP_XONXOFF_DISABLED = 0,
174 /** XON/XOFF enabled for input only. */
176 /** XON/XOFF enabled for output only. */
178 /** XON/XOFF enabled for input and output. */
179 SP_XONXOFF_INOUT = 3,
182 /** Standard flow control combinations. */
183 enum sp_flowcontrol {
184 /** No flow control. */
185 SP_FLOWCONTROL_NONE = 0,
186 /** Software flow control using XON/XOFF characters. */
187 SP_FLOWCONTROL_XONXOFF = 1,
188 /** Hardware flow control using RTS/CTS signals. */
189 SP_FLOWCONTROL_RTSCTS = 2,
190 /** Hardware flow control using DTR/DSR signals. */
191 SP_FLOWCONTROL_DTRDSR = 3,
194 /** A serial port. */
196 /** Name used to open the port. */
199 /** OS-specific port handle. */
208 /** Configuration for a serial port. */
209 struct sp_port_config {
210 /** Baud rate in bits per second. */
212 /** Number of data bits to use. Valid values are 5 to 8. */
214 /** Parity setting to use. */
215 enum sp_parity parity;
216 /** Number of stop bits to use (1 or 2). */
226 /** XON/XOFF flow control mode. */
227 enum sp_xonxoff xon_xoff;
231 @defgroup Enumeration Port enumeration
236 * Obtain a pointer to a new sp_port structure representing the named port.
238 * The user should allocate a variable of type "struct sp_port *" and pass a
239 * pointer to this to receive the result.
241 * The result should be freed after use by calling sp_free_port().
243 * @return SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
244 * failure, or SP_ERR_ARG if an invalid pointer is passed. If any error
245 * is returned, the variable pointed to by port_ptr will be set to NULL.
246 * Otherwise, it will be set to point to the newly allocated port.
248 enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
251 * Free a port structure obtained from sp_get_port_by_name() or sp_copy_port().
253 void sp_free_port(struct sp_port *port);
256 * List the serial ports available on the system.
258 * The result obtained is an array of pointers to sp_port structures,
259 * terminated by a NULL. The user should allocate a variable of type
260 * "struct sp_port **" and pass a pointer to this to receive the result.
262 * The result should be freed after use by calling sp_free_port_list().
263 * If a port from the list is to be used after freeing the list, it must be
264 * copied first using sp_copy_port().
266 * @return SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
267 * failure, or SP_ERR_ARG if an invalid pointer is passed. If any error
268 * is returned, the variable pointed to by list_ptr will be set to NULL.
269 * Otherwise, it will be set to point to the newly allocated array.
271 enum sp_return sp_list_ports(struct sp_port ***list_ptr);
274 * Make a new copy of a sp_port structure.
276 * The user should allocate a variable of type "struct sp_port *" and pass a
277 * pointer to this to receive the result.
279 * The copy should be freed after use by calling sp_free_port().
281 * @return SP_OK on success, SP_ERR_MEM on allocation failure, or SP_ERR_ARG
282 * if an invalid port or pointer is passed. If any error is returned,
283 * the variable pointed to by copy_ptr will be set to NULL. Otherwise,
284 * it will be set to point to the newly allocated copy.
286 enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr);
289 * Free a port list obtained from sp_list_ports().
291 * This will also free all the sp_port structures referred to from the list;
292 * any that are to be retained must be copied first using sp_copy_port().
294 void sp_free_port_list(struct sp_port **ports);
298 * @defgroup Ports Opening and closing ports
303 * Open the specified serial port.
305 * @param port Pointer to port structure.
306 * @param flags Flags to use when opening the serial port.
308 * @return SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
309 * failure, or SP_ERR_ARG if an invalid port is passed.
311 enum sp_return sp_open(struct sp_port *port, enum sp_mode flags);
314 * Close the specified serial port.
316 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
317 * if an invalid port is passed.
319 enum sp_return sp_close(struct sp_port *port);
323 * @defgroup Configuration Setting port parameters
328 * Get the current configuration of the specified serial port.
330 * The user should allocate a struct sp_port_config, then pass a pointer to it
331 * as the config parameter. The struct will be populated with the port
334 * Any setting that is in a state not recognised or supported by
335 * libserialport will have its value set to -1 in the struct.
337 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
338 * for invalid arguments.
340 enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config);
343 * Set the configuration for the specified serial port.
345 * The user should populate a struct sp_port_config, then pass a pointer to it
346 * as the config parameter.
348 * To retain the current value of any setting, set that field to -1.
350 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
351 * for invalid arguments.
353 enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config);
356 * Set the baud rate for the specified serial port.
358 * @param port Pointer to port structure.
359 * @param baudrate Baud rate in bits per second.
361 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
362 * for invalid arguments.
364 enum sp_return sp_set_baudrate(struct sp_port *port, int baudrate);
367 * Set the number of data bits for the specified serial port.
369 * @param port Pointer to port structure.
370 * @param bits Number of data bits to use. Valid values are 5 to 8.
372 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
373 * for invalid arguments.
375 enum sp_return sp_set_bits(struct sp_port *port, int bits);
378 * Set the parity for the specified serial port.
380 * @param port Pointer to port structure.
381 * @param parity Parity setting to use.
383 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
384 * for invalid arguments.
386 enum sp_return sp_set_parity(struct sp_port *port, enum sp_parity parity);
389 * Set the number of stop bits for the specified port.
391 * @param port Pointer to port structure.
392 * @param stopbits Number of stop bits to use (1 or 2).
394 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
395 * for invalid arguments.
397 enum sp_return sp_set_stopbits(struct sp_port *port, int stopbits);
400 * Set the flow control type for the specified serial port.
402 * This function is a wrapper that sets the RTS, CTS, DTR, DSR and
403 * XON/XOFF settings as necessary for the specified flow control
404 * type. For more fine-grained control of these settings, use their
405 * individual configuration functions or the sp_set_config() function.
407 * @param port Pointer to port structure.
408 * @param flowcontrol Flow control setting to use.
410 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
411 * for invalid arguments.
413 enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol);
416 * Set the RTS pin behaviour for the specified port.
418 * @param port Pointer to port structure.
419 * @param rts RTS pin mode.
421 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
422 * for invalid arguments.
424 enum sp_return sp_set_rts(struct sp_port *port, enum sp_rts rts);
427 * Set the CTS pin behaviour for the specified port.
429 * @param port Pointer to port structure.
430 * @param cts CTS pin mode.
432 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
433 * for invalid arguments.
435 enum sp_return sp_set_cts(struct sp_port *port, enum sp_cts cts);
438 * Set the DTR pin behaviour for the specified port.
440 * @param port Pointer to port structure.
441 * @param dtr DTR pin mode.
443 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
444 * for invalid arguments.
446 enum sp_return sp_set_dtr(struct sp_port *port, enum sp_dtr dtr);
449 * Set the RTS pin behaviour for the specified port.
451 * @param port Pointer to port structure.
452 * @param dsr DSR pin mode.
454 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
455 * for invalid arguments.
457 enum sp_return sp_set_dsr(struct sp_port *port, enum sp_dsr dsr);
460 * Configure XON/XOFF flow control for the specified port.
462 * @param port Pointer to port structure.
463 * @param xon_xoff XON/XOFF flow control mode.
465 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
466 * for invalid arguments.
468 enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff);
472 * @defgroup Data Reading, writing, and flushing data
477 * Read bytes from the specified serial port.
479 * Note that this function may return after reading less than the specified
480 * number of bytes; it is the user's responsibility to iterate as necessary
483 * @param port Pointer to port structure.
484 * @param buf Buffer in which to store the bytes read.
485 * @param count Maximum number of bytes to read.
487 * @return The number of bytes read, SP_ERR_FAIL on failure,
488 * or SP_ERR_ARG for invalid arguments.
490 enum sp_return sp_read(struct sp_port *port, void *buf, size_t count);
493 * Write bytes to the specified serial port.
495 * Note that this function may return after writing less than the specified
496 * number of bytes; it is the user's responsibility to iterate as necessary
499 * @param port Pointer to port structure.
500 * @param buf Buffer containing the bytes to write.
501 * @param count Maximum number of bytes to write.
503 * @return The number of bytes written, SP_ERR_FAIL on failure,
504 * or SP_ERR_ARG for invalid arguments.
506 enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count);
509 * Flush serial port buffers.
511 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
512 * if an invalid port is passed.
514 enum sp_return sp_flush(struct sp_port *port);
518 * @defgroup Errors Obtaining error information
523 * Get the error code for a failed operation.
525 * In order to obtain the correct result, this function should be called
526 * straight after the failure, before executing any other system operations.
528 * @return The system's numeric code for the error that caused the last
531 int sp_last_error_code(void);
534 * Get the error message for a failed operation.
536 * In order to obtain the correct result, this function should be called
537 * straight after the failure, before executing other system operations.
539 * @return The system's message for the error that caused the last
540 * operation to fail. This string may be allocated by the function,
541 * and should be freed after use by calling sp_free_error_message().
543 char *sp_last_error_message(void);
546 * Free an error message returned by sp_last_error_message().
548 void sp_free_error_message(char *message);
556 #endif /* LIBSERIALPORT_H */