]>
Commit | Line | Data |
---|---|---|
74510d4b ML |
1 | /* |
2 | * This file is part of the libserialport project. | |
3 | * | |
4 | * Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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/>. | |
18 | */ | |
19 | ||
cd5f5281 | 20 | /** |
cf9d365c UH |
21 | * @mainpage libserialport API |
22 | * | |
23 | * Introduction | |
24 | * ============ | |
25 | * | |
26 | * libserialport is a minimal library written in C that is intended to take | |
27 | * care of the OS-specific details when writing software that uses serial ports. | |
28 | * | |
29 | * By writing your serial code to use libserialport, you enable it to work | |
30 | * transparently on any platform supported by the library. | |
31 | * | |
32 | * The operations that are supported are: | |
33 | * | |
34 | * - @ref Enumeration (obtaining a list of serial ports on the system) | |
35 | * - @ref Ports | |
36 | * - @ref Configuration (baud rate, parity, etc.) | |
0151b157 | 37 | * - @ref Signals (modem control lines, breaks, etc.) |
cf9d365c | 38 | * - @ref Data |
6f1186aa | 39 | * - @ref Waiting |
cf9d365c UH |
40 | * - @ref Errors |
41 | * | |
42 | * libserialport is an open source project released under the LGPL3+ license. | |
43 | * | |
44 | * API principles | |
45 | * ============== | |
46 | * | |
47 | * The API is simple, and designed to be a minimal wrapper around the serial | |
48 | * port support in each OS. | |
49 | * | |
50 | * Most functions take a pointer to a struct sp_port, which represents a serial | |
51 | * port. These structures are always allocated and freed by the library, using | |
52 | * the functions in the @ref Enumeration "Enumeration" section. | |
53 | * | |
0151b157 ML |
54 | * Most functions have return type @ref sp_return and can return only four |
55 | * possible error values: | |
cf9d365c | 56 | * |
6aabf62a ML |
57 | * - @ref SP_ERR_ARG means that a function was called with invalid |
58 | * arguments. This implies a bug in the caller. The arguments passed would | |
59 | * be invalid regardless of the underlying OS or serial device involved. | |
60 | * | |
61 | * - @ref SP_ERR_FAIL means that the OS reported a failure. The error code or | |
62 | * message provided by the OS can be obtained by calling sp_last_error_code() | |
63 | * or sp_last_error_message(). | |
64 | * | |
65 | * - @ref SP_ERR_SUPP indicates that there is no support for the requested | |
66 | * operation in the current OS, driver or device. No error message is | |
67 | * available from the OS in this case. There is either no way to request | |
68 | * the operation in the first place, or libserialport does not know how to | |
69 | * do so in the current version. | |
70 | * | |
71 | * - @ref SP_ERR_MEM indicates that a memory allocation failed. | |
72 | * | |
73 | * All of these error values are negative. | |
cf9d365c | 74 | * |
0151b157 ML |
75 | * Calls that succeed return @ref SP_OK, which is equal to zero. Some functions |
76 | * declared @ref sp_return can also return a positive value for a successful | |
0a1ab8bf | 77 | * numeric result, e.g. sp_blocking_read() or sp_blocking_write(). |
cf9d365c | 78 | */ |
cd5f5281 | 79 | |
8645feda UH |
80 | #ifndef LIBSERIALPORT_LIBSERIALPORT_H |
81 | #define LIBSERIALPORT_LIBSERIALPORT_H | |
e8ffaee9 | 82 | |
5ef8a1ed UH |
83 | #ifdef __cplusplus |
84 | extern "C" { | |
85 | #endif | |
86 | ||
74510d4b | 87 | #include <stddef.h> |
74510d4b | 88 | |
cd5f5281 | 89 | /** Return values. */ |
eb6ed20f | 90 | enum sp_return { |
cd5f5281 | 91 | /** Operation completed successfully. */ |
74510d4b | 92 | SP_OK = 0, |
cd5f5281 | 93 | /** Invalid arguments were passed to the function. */ |
e9a2f9c9 | 94 | SP_ERR_ARG = -1, |
cfa5af67 | 95 | /** A system error occurred while executing the operation. */ |
e9a2f9c9 | 96 | SP_ERR_FAIL = -2, |
cd5f5281 | 97 | /** A memory allocation failed while executing the operation. */ |
f92f1f0c | 98 | SP_ERR_MEM = -3, |
6aabf62a | 99 | /** The requested operation is not supported by this system or device. */ |
79a80046 | 100 | SP_ERR_SUPP = -4 |
74510d4b ML |
101 | }; |
102 | ||
cd5f5281 | 103 | /** Port access modes. */ |
eb6ed20f | 104 | enum sp_mode { |
a036341b ML |
105 | /** Open port for read access. */ |
106 | SP_MODE_READ = 1, | |
107 | /** Open port for write access. */ | |
276ef1b9 | 108 | SP_MODE_WRITE = 2, |
13efecf8 | 109 | /** Open port for read and write access. @since 0.1.1 */ |
276ef1b9 | 110 | SP_MODE_READ_WRITE = 3 |
74510d4b ML |
111 | }; |
112 | ||
6f1186aa ML |
113 | /** Port events. */ |
114 | enum sp_event { | |
144a598f | 115 | /** Data received and ready to read. */ |
6f1186aa | 116 | SP_EVENT_RX_READY = 1, |
144a598f | 117 | /** Ready to transmit new data. */ |
6f1186aa | 118 | SP_EVENT_TX_READY = 2, |
144a598f | 119 | /** Error occurred. */ |
79a80046 | 120 | SP_EVENT_ERROR = 4 |
6f1186aa ML |
121 | }; |
122 | ||
fd8fd11a ML |
123 | /** Buffer selection. */ |
124 | enum sp_buffer { | |
125 | /** Input buffer. */ | |
126 | SP_BUF_INPUT = 1, | |
127 | /** Output buffer. */ | |
128 | SP_BUF_OUTPUT = 2, | |
129 | /** Both buffers. */ | |
79a80046 | 130 | SP_BUF_BOTH = 3 |
fd8fd11a ML |
131 | }; |
132 | ||
cd5f5281 | 133 | /** Parity settings. */ |
eb6ed20f | 134 | enum sp_parity { |
c200f5c1 | 135 | /** Special value to indicate setting should be left alone. */ |
eb6ed20f | 136 | SP_PARITY_INVALID = -1, |
cd5f5281 | 137 | /** No parity. */ |
74510d4b | 138 | SP_PARITY_NONE = 0, |
cd5f5281 | 139 | /** Odd parity. */ |
20e63a77 ML |
140 | SP_PARITY_ODD = 1, |
141 | /** Even parity. */ | |
142 | SP_PARITY_EVEN = 2, | |
e432ce60 ML |
143 | /** Mark parity. */ |
144 | SP_PARITY_MARK = 3, | |
145 | /** Space parity. */ | |
79a80046 | 146 | SP_PARITY_SPACE = 4 |
74510d4b ML |
147 | }; |
148 | ||
cd5f5281 | 149 | /** RTS pin behaviour. */ |
eb6ed20f | 150 | enum sp_rts { |
c200f5c1 | 151 | /** Special value to indicate setting should be left alone. */ |
eb6ed20f | 152 | SP_RTS_INVALID = -1, |
cd5f5281 | 153 | /** RTS off. */ |
d514a26f | 154 | SP_RTS_OFF = 0, |
cd5f5281 | 155 | /** RTS on. */ |
d514a26f | 156 | SP_RTS_ON = 1, |
cd5f5281 | 157 | /** RTS used for flow control. */ |
79a80046 | 158 | SP_RTS_FLOW_CONTROL = 2 |
d514a26f ML |
159 | }; |
160 | ||
cd5f5281 | 161 | /** CTS pin behaviour. */ |
eb6ed20f | 162 | enum sp_cts { |
c200f5c1 | 163 | /** Special value to indicate setting should be left alone. */ |
eb6ed20f | 164 | SP_CTS_INVALID = -1, |
cd5f5281 | 165 | /** CTS ignored. */ |
d514a26f | 166 | SP_CTS_IGNORE = 0, |
cd5f5281 | 167 | /** CTS used for flow control. */ |
79a80046 | 168 | SP_CTS_FLOW_CONTROL = 1 |
d514a26f ML |
169 | }; |
170 | ||
cd5f5281 | 171 | /** DTR pin behaviour. */ |
eb6ed20f | 172 | enum sp_dtr { |
c200f5c1 | 173 | /** Special value to indicate setting should be left alone. */ |
eb6ed20f | 174 | SP_DTR_INVALID = -1, |
cd5f5281 | 175 | /** DTR off. */ |
d514a26f | 176 | SP_DTR_OFF = 0, |
cd5f5281 | 177 | /** DTR on. */ |
d514a26f | 178 | SP_DTR_ON = 1, |
cd5f5281 | 179 | /** DTR used for flow control. */ |
79a80046 | 180 | SP_DTR_FLOW_CONTROL = 2 |
d514a26f ML |
181 | }; |
182 | ||
cd5f5281 | 183 | /** DSR pin behaviour. */ |
eb6ed20f | 184 | enum sp_dsr { |
c200f5c1 | 185 | /** Special value to indicate setting should be left alone. */ |
eb6ed20f | 186 | SP_DSR_INVALID = -1, |
cd5f5281 | 187 | /** DSR ignored. */ |
d514a26f | 188 | SP_DSR_IGNORE = 0, |
cd5f5281 | 189 | /** DSR used for flow control. */ |
79a80046 | 190 | SP_DSR_FLOW_CONTROL = 1 |
d514a26f ML |
191 | }; |
192 | ||
cd5f5281 | 193 | /** XON/XOFF flow control behaviour. */ |
eb6ed20f | 194 | enum sp_xonxoff { |
c200f5c1 | 195 | /** Special value to indicate setting should be left alone. */ |
eb6ed20f | 196 | SP_XONXOFF_INVALID = -1, |
cd5f5281 | 197 | /** XON/XOFF disabled. */ |
d514a26f | 198 | SP_XONXOFF_DISABLED = 0, |
cd5f5281 | 199 | /** XON/XOFF enabled for input only. */ |
d514a26f | 200 | SP_XONXOFF_IN = 1, |
cd5f5281 | 201 | /** XON/XOFF enabled for output only. */ |
d514a26f | 202 | SP_XONXOFF_OUT = 2, |
cd5f5281 | 203 | /** XON/XOFF enabled for input and output. */ |
79a80046 | 204 | SP_XONXOFF_INOUT = 3 |
ac74fdaf ML |
205 | }; |
206 | ||
cd5f5281 | 207 | /** Standard flow control combinations. */ |
eb6ed20f | 208 | enum sp_flowcontrol { |
cd5f5281 | 209 | /** No flow control. */ |
18fc2dd1 | 210 | SP_FLOWCONTROL_NONE = 0, |
cd5f5281 | 211 | /** Software flow control using XON/XOFF characters. */ |
18fc2dd1 | 212 | SP_FLOWCONTROL_XONXOFF = 1, |
cd5f5281 | 213 | /** Hardware flow control using RTS/CTS signals. */ |
18fc2dd1 | 214 | SP_FLOWCONTROL_RTSCTS = 2, |
cd5f5281 | 215 | /** Hardware flow control using DTR/DSR signals. */ |
79a80046 | 216 | SP_FLOWCONTROL_DTRDSR = 3 |
18fc2dd1 ML |
217 | }; |
218 | ||
8cf7c697 ML |
219 | /** Input signals. */ |
220 | enum sp_signal { | |
221 | /** Clear to send. */ | |
222 | SP_SIG_CTS = 1, | |
223 | /** Data set ready. */ | |
224 | SP_SIG_DSR = 2, | |
225 | /** Data carrier detect. */ | |
226 | SP_SIG_DCD = 4, | |
227 | /** Ring indicator. */ | |
79a80046 | 228 | SP_SIG_RI = 8 |
8cf7c697 ML |
229 | }; |
230 | ||
13efecf8 UH |
231 | /** |
232 | * Transport types. | |
233 | * | |
234 | * @since 0.1.1 | |
235 | */ | |
a93fb468 | 236 | enum sp_transport { |
13efecf8 | 237 | /** Native platform serial port. @since 0.1.1 */ |
a93fb468 | 238 | SP_TRANSPORT_NATIVE, |
13efecf8 | 239 | /** USB serial port adapter. @since 0.1.1 */ |
a93fb468 | 240 | SP_TRANSPORT_USB, |
13efecf8 | 241 | /** Bluetooth serial port adapter. @since 0.1.1 */ |
79a80046 | 242 | SP_TRANSPORT_BLUETOOTH |
a93fb468 AJ |
243 | }; |
244 | ||
0a1ab8bf UH |
245 | /** |
246 | * @struct sp_port | |
247 | * An opaque structure representing a serial port. | |
248 | */ | |
1c5aae9d | 249 | struct sp_port; |
eb6ed20f | 250 | |
0a1ab8bf UH |
251 | /** |
252 | * @struct sp_port_config | |
253 | * An opaque structure representing the configuration for a serial port. | |
254 | */ | |
9b1502ef | 255 | struct sp_port_config; |
eb6ed20f | 256 | |
6f1186aa ML |
257 | /** |
258 | * @struct sp_event_set | |
259 | * A set of handles to wait on for events. | |
260 | */ | |
261 | struct sp_event_set { | |
262 | /** Array of OS-specific handles. */ | |
263 | void *handles; | |
264 | /** Array of bitmasks indicating which events apply for each handle. */ | |
265 | enum sp_event *masks; | |
266 | /** Number of handles. */ | |
267 | unsigned int count; | |
268 | }; | |
269 | ||
091e75fe | 270 | /** |
144a598f UH |
271 | * @defgroup Enumeration Port enumeration |
272 | * | |
273 | * Enumerating the serial ports of a system. | |
274 | * | |
275 | * @{ | |
276 | */ | |
091e75fe | 277 | |
cd5f5281 | 278 | /** |
cf9d365c UH |
279 | * Obtain a pointer to a new sp_port structure representing the named port. |
280 | * | |
281 | * The user should allocate a variable of type "struct sp_port *" and pass a | |
282 | * pointer to this to receive the result. | |
283 | * | |
284 | * The result should be freed after use by calling sp_free_port(). | |
285 | * | |
35578b06 UH |
286 | * @param[in] portname The OS-specific name of a serial port. Must not be NULL. |
287 | * @param[out] port_ptr If any error is returned, the variable pointed to by | |
288 | * port_ptr will be set to NULL. Otherwise, it will be set | |
289 | * to point to the newly allocated port. Must not be NULL. | |
f36c6395 ML |
290 | * |
291 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
292 | * |
293 | * @since 0.1.0 | |
cf9d365c | 294 | */ |
eb6ed20f | 295 | enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr); |
cd5f5281 ML |
296 | |
297 | /** | |
cf9d365c | 298 | * Free a port structure obtained from sp_get_port_by_name() or sp_copy_port(). |
1652aa86 | 299 | * |
35578b06 UH |
300 | * @param[in] port Pointer to a port structure. Must not be NULL. |
301 | * | |
1652aa86 | 302 | * @since 0.1.0 |
cf9d365c | 303 | */ |
e3b2f7a4 | 304 | void sp_free_port(struct sp_port *port); |
cd5f5281 ML |
305 | |
306 | /** | |
cf9d365c UH |
307 | * List the serial ports available on the system. |
308 | * | |
309 | * The result obtained is an array of pointers to sp_port structures, | |
310 | * terminated by a NULL. The user should allocate a variable of type | |
311 | * "struct sp_port **" and pass a pointer to this to receive the result. | |
312 | * | |
313 | * The result should be freed after use by calling sp_free_port_list(). | |
314 | * If a port from the list is to be used after freeing the list, it must be | |
315 | * copied first using sp_copy_port(). | |
316 | * | |
35578b06 UH |
317 | * @param[out] list_ptr If any error is returned, the variable pointed to by |
318 | * list_ptr will be set to NULL. Otherwise, it will be set | |
319 | * to point to the newly allocated array. Must not be NULL. | |
f36c6395 ML |
320 | * |
321 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
322 | * |
323 | * @since 0.1.0 | |
cf9d365c | 324 | */ |
eb6ed20f | 325 | enum sp_return sp_list_ports(struct sp_port ***list_ptr); |
cd5f5281 ML |
326 | |
327 | /** | |
35578b06 | 328 | * Make a new copy of an sp_port structure. |
cf9d365c UH |
329 | * |
330 | * The user should allocate a variable of type "struct sp_port *" and pass a | |
331 | * pointer to this to receive the result. | |
332 | * | |
333 | * The copy should be freed after use by calling sp_free_port(). | |
334 | * | |
35578b06 UH |
335 | * @param[in] port Pointer to a port structure. Must not be NULL. |
336 | * @param[out] copy_ptr If any error is returned, the variable pointed to by | |
337 | * copy_ptr will be set to NULL. Otherwise, it will be set | |
338 | * to point to the newly allocated copy. Must not be NULL. | |
f36c6395 ML |
339 | * |
340 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
341 | * |
342 | * @since 0.1.0 | |
cf9d365c | 343 | */ |
eb6ed20f | 344 | enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr); |
cd5f5281 ML |
345 | |
346 | /** | |
cf9d365c UH |
347 | * Free a port list obtained from sp_list_ports(). |
348 | * | |
349 | * This will also free all the sp_port structures referred to from the list; | |
350 | * any that are to be retained must be copied first using sp_copy_port(). | |
1652aa86 | 351 | * |
35578b06 UH |
352 | * @param[in] ports Pointer to a list of port structures. Must not be NULL. |
353 | * | |
1652aa86 | 354 | * @since 0.1.0 |
cf9d365c | 355 | */ |
d54e9004 | 356 | void sp_free_port_list(struct sp_port **ports); |
e96d8bd2 | 357 | |
091e75fe | 358 | /** |
cf9d365c | 359 | * @} |
144a598f UH |
360 | * @defgroup Ports Port handling |
361 | * | |
362 | * Opening, closing and querying ports. | |
363 | * | |
cf9d365c UH |
364 | * @{ |
365 | */ | |
091e75fe | 366 | |
cd5f5281 | 367 | /** |
cf9d365c UH |
368 | * Open the specified serial port. |
369 | * | |
35578b06 UH |
370 | * @param[in] port Pointer to a port structure. Must not be NULL. |
371 | * @param[in] flags Flags to use when opening the serial port. | |
cf9d365c | 372 | * |
f36c6395 | 373 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
374 | * |
375 | * @since 0.1.0 | |
cf9d365c | 376 | */ |
eb6ed20f | 377 | enum sp_return sp_open(struct sp_port *port, enum sp_mode flags); |
cd5f5281 ML |
378 | |
379 | /** | |
cf9d365c UH |
380 | * Close the specified serial port. |
381 | * | |
35578b06 UH |
382 | * @param[in] port Pointer to a port structure. Must not be NULL. |
383 | * | |
f36c6395 | 384 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
385 | * |
386 | * @since 0.1.0 | |
cf9d365c | 387 | */ |
eb6ed20f | 388 | enum sp_return sp_close(struct sp_port *port); |
e96d8bd2 | 389 | |
0151b157 ML |
390 | /** |
391 | * Get the name of a port. | |
392 | * | |
393 | * The name returned is whatever is normally used to refer to a port on the | |
394 | * current operating system; e.g. for Windows it will usually be a "COMn" | |
395 | * device name, and for Unix it will be a device path beginning with "/dev/". | |
396 | * | |
35578b06 | 397 | * @param[in] port Pointer to a port structure. Must not be NULL. |
0151b157 ML |
398 | * |
399 | * @return The port name, or NULL if an invalid port is passed. The name | |
35578b06 UH |
400 | * string is part of the port structure and may not be used after |
401 | * the port structure has been freed. | |
1652aa86 UH |
402 | * |
403 | * @since 0.1.0 | |
0151b157 ML |
404 | */ |
405 | char *sp_get_port_name(const struct sp_port *port); | |
406 | ||
a93fb468 AJ |
407 | /** |
408 | * Get a description for a port, to present to end user. | |
409 | * | |
35578b06 | 410 | * @param[in] port Pointer to a port structure. Must not be NULL. |
a93fb468 AJ |
411 | * |
412 | * @return The port description, or NULL if an invalid port is passed. | |
35578b06 UH |
413 | * The description string is part of the port structure and may not |
414 | * be used after the port structure has been freed. | |
a93fb468 | 415 | * |
3f2f48fc | 416 | * @since 0.1.1 |
a93fb468 | 417 | */ |
f1480939 | 418 | char *sp_get_port_description(const struct sp_port *port); |
a93fb468 AJ |
419 | |
420 | /** | |
421 | * Get the transport type used by a port. | |
422 | * | |
35578b06 | 423 | * @param[in] port Pointer to a port structure. Must not be NULL. |
a93fb468 AJ |
424 | * |
425 | * @return The port transport type. | |
426 | * | |
3f2f48fc | 427 | * @since 0.1.1 |
a93fb468 | 428 | */ |
ad036cc8 | 429 | enum sp_transport sp_get_port_transport(const struct sp_port *port); |
a93fb468 AJ |
430 | |
431 | /** | |
432 | * Get the USB bus number and address on bus of a USB serial adapter port. | |
433 | * | |
35578b06 UH |
434 | * @param[in] port Pointer to a port structure. Must not be NULL. |
435 | * @param[out] usb_bus Pointer to a variable to store the USB bus. Must not be NULL. | |
436 | * @param[out] usb_address Pointer to a variable to store the USB address. Must not be NULL. | |
a93fb468 AJ |
437 | * |
438 | * @return SP_OK upon success, a negative error code otherwise. | |
439 | * | |
3f2f48fc | 440 | * @since 0.1.1 |
a93fb468 AJ |
441 | */ |
442 | enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port, | |
443 | int *usb_bus, int *usb_address); | |
444 | ||
445 | /** | |
446 | * Get the USB Vendor ID and Product ID of a USB serial adapter port. | |
447 | * | |
35578b06 | 448 | * @param[in] port Pointer to a port structure. Must not be NULL. |
9eb9f071 UH |
449 | * @param[out] usb_vid Pointer to a variable to store the USB VID. |
450 | * Can be NULL (in that case it will be ignored). | |
451 | * @param[out] usb_pid Pointer to a variable to store the USB PID. | |
452 | * Can be NULL (in that case it will be ignored). | |
a93fb468 AJ |
453 | * |
454 | * @return SP_OK upon success, a negative error code otherwise. | |
455 | * | |
3f2f48fc | 456 | * @since 0.1.1 |
a93fb468 AJ |
457 | */ |
458 | enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, int *usb_vid, int *usb_pid); | |
459 | ||
460 | /** | |
461 | * Get the USB manufacturer string of a USB serial adapter port. | |
462 | * | |
35578b06 | 463 | * @param[in] port Pointer to a port structure. Must not be NULL. |
a93fb468 AJ |
464 | * |
465 | * @return The port manufacturer string, or NULL if an invalid port is passed. | |
35578b06 UH |
466 | * The manufacturer string is part of the port structure and may not |
467 | * be used after the port structure has been freed. | |
a93fb468 | 468 | * |
3f2f48fc | 469 | * @since 0.1.1 |
a93fb468 AJ |
470 | */ |
471 | char *sp_get_port_usb_manufacturer(const struct sp_port *port); | |
472 | ||
473 | /** | |
474 | * Get the USB product string of a USB serial adapter port. | |
475 | * | |
35578b06 | 476 | * @param[in] port Pointer to a port structure. Must not be NULL. |
a93fb468 AJ |
477 | * |
478 | * @return The port product string, or NULL if an invalid port is passed. | |
35578b06 UH |
479 | * The product string is part of the port structure and may not be |
480 | * used after the port structure has been freed. | |
a93fb468 | 481 | * |
3f2f48fc | 482 | * @since 0.1.1 |
a93fb468 AJ |
483 | */ |
484 | char *sp_get_port_usb_product(const struct sp_port *port); | |
485 | ||
486 | /** | |
487 | * Get the USB serial number string of a USB serial adapter port. | |
488 | * | |
35578b06 | 489 | * @param[in] port Pointer to a port structure. Must not be NULL. |
a93fb468 AJ |
490 | * |
491 | * @return The port serial number, or NULL if an invalid port is passed. | |
35578b06 UH |
492 | * The serial number string is part of the port structure and may |
493 | * not be used after the port structure has been freed. | |
a93fb468 | 494 | * |
3f2f48fc | 495 | * @since 0.1.1 |
a93fb468 AJ |
496 | */ |
497 | char *sp_get_port_usb_serial(const struct sp_port *port); | |
498 | ||
499 | /** | |
e33dcf90 | 500 | * Get the MAC address of a Bluetooth serial adapter port. |
a93fb468 | 501 | * |
35578b06 | 502 | * @param[in] port Pointer to a port structure. Must not be NULL. |
a93fb468 | 503 | * |
e33dcf90 | 504 | * @return The port MAC address, or NULL if an invalid port is passed. |
35578b06 UH |
505 | * The MAC address string is part of the port structure and may not |
506 | * be used after the port structure has been freed. | |
a93fb468 | 507 | * |
3f2f48fc | 508 | * @since 0.1.1 |
a93fb468 AJ |
509 | */ |
510 | char *sp_get_port_bluetooth_address(const struct sp_port *port); | |
511 | ||
0151b157 ML |
512 | /** |
513 | * Get the operating system handle for a port. | |
514 | * | |
515 | * The type of the handle depends on the operating system. On Unix based | |
516 | * systems, the handle is a file descriptor of type "int". On Windows, the | |
517 | * handle is of type "HANDLE". The user should allocate a variable of the | |
518 | * appropriate type and pass a pointer to this to receive the result. | |
519 | * | |
520 | * To obtain a valid handle, the port must first be opened by calling | |
521 | * sp_open() using the same port structure. | |
522 | * | |
523 | * After the port is closed or the port structure freed, the handle may | |
524 | * no longer be valid. | |
525 | * | |
526 | * @warning This feature is provided so that programs may make use of | |
527 | * OS-specific functionality where desired. Doing so obviously | |
528 | * comes at a cost in portability. It also cannot be guaranteed | |
529 | * that direct usage of the OS handle will not conflict with the | |
530 | * library's own usage of the port. Be careful. | |
531 | * | |
35578b06 UH |
532 | * @param[in] port Pointer to a port structure. Must not be NULL. |
533 | * @param[out] result_ptr If any error is returned, the variable pointed to by | |
534 | * result_ptr will be set to NULL. Otherwise, it will | |
535 | * be set to point to the OS handle. Must not be NULL. | |
536 | * | |
0151b157 | 537 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
538 | * |
539 | * @since 0.1.0 | |
0151b157 ML |
540 | */ |
541 | enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr); | |
542 | ||
cd5f5281 | 543 | /** |
cf9d365c | 544 | * @} |
144a598f UH |
545 | * |
546 | * @defgroup Configuration Configuration | |
547 | * | |
548 | * Setting and querying serial port parameters. | |
cf9d365c UH |
549 | * @{ |
550 | */ | |
e96d8bd2 | 551 | |
9b1502ef ML |
552 | /** |
553 | * Allocate a port configuration structure. | |
554 | * | |
555 | * The user should allocate a variable of type "struct sp_config *" and pass a | |
556 | * pointer to this to receive the result. The variable will be updated to | |
557 | * point to the new configuration structure. The structure is opaque and must | |
558 | * be accessed via the functions provided. | |
559 | * | |
560 | * All parameters in the structure will be initialised to special values which | |
561 | * are ignored by sp_set_config(). | |
562 | * | |
563 | * The structure should be freed after use by calling sp_free_config(). | |
564 | * | |
35578b06 UH |
565 | * @param[out] config_ptr Pointer to a variable to receive the result. |
566 | * Must not be NULL. | |
9b1502ef ML |
567 | * |
568 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
569 | * |
570 | * @since 0.1.0 | |
9b1502ef ML |
571 | */ |
572 | enum sp_return sp_new_config(struct sp_port_config **config_ptr); | |
573 | ||
574 | /** | |
575 | * Free a port configuration structure. | |
576 | * | |
35578b06 | 577 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
1652aa86 UH |
578 | * |
579 | * @since 0.1.0 | |
9b1502ef ML |
580 | */ |
581 | void sp_free_config(struct sp_port_config *config); | |
582 | ||
cd5f5281 | 583 | /** |
cf9d365c UH |
584 | * Get the current configuration of the specified serial port. |
585 | * | |
9b1502ef ML |
586 | * The user should allocate a configuration structure using sp_new_config() |
587 | * and pass this as the config parameter. The configuration structure will | |
588 | * be updated with the port configuration. | |
cf9d365c | 589 | * |
9b1502ef ML |
590 | * Any parameters that are configured with settings not recognised or |
591 | * supported by libserialport, will be set to special values that are | |
592 | * ignored by sp_set_config(). | |
cf9d365c | 593 | * |
35578b06 UH |
594 | * @param[in] port Pointer to a port structure. Must not be NULL. |
595 | * @param[out] config Pointer to a configuration structure that will hold | |
596 | * the result. Must not be NULL. | |
597 | * | |
f36c6395 | 598 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
599 | * |
600 | * @since 0.1.0 | |
cf9d365c | 601 | */ |
eb6ed20f | 602 | enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config); |
cd5f5281 ML |
603 | |
604 | /** | |
cf9d365c UH |
605 | * Set the configuration for the specified serial port. |
606 | * | |
9b1502ef ML |
607 | * For each parameter in the configuration, there is a special value (usually |
608 | * -1, but see the documentation for each field). These values will be ignored | |
609 | * and the corresponding setting left unchanged on the port. | |
cf9d365c | 610 | * |
35578b06 UH |
611 | * @param[in] port Pointer to a port structure. Must not be NULL. |
612 | * @param[in] config Pointer to a configuration structure. Must not be NULL. | |
613 | * | |
f36c6395 | 614 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
615 | * |
616 | * @since 0.1.0 | |
cf9d365c | 617 | */ |
eb6ed20f | 618 | enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config); |
cd5f5281 ML |
619 | |
620 | /** | |
cf9d365c UH |
621 | * Set the baud rate for the specified serial port. |
622 | * | |
35578b06 UH |
623 | * @param[in] port Pointer to a port structure. Must not be NULL. |
624 | * @param[in] baudrate Baud rate in bits per second. | |
cf9d365c | 625 | * |
f36c6395 | 626 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
627 | * |
628 | * @since 0.1.0 | |
cf9d365c | 629 | */ |
eb6ed20f | 630 | enum sp_return sp_set_baudrate(struct sp_port *port, int baudrate); |
cd5f5281 ML |
631 | |
632 | /** | |
9b1502ef ML |
633 | * Get the baud rate from a port configuration. |
634 | * | |
35578b06 UH |
635 | * The user should allocate a variable of type int and |
636 | * pass a pointer to this to receive the result. | |
9b1502ef | 637 | * |
35578b06 UH |
638 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
639 | * @param[out] baudrate_ptr Pointer to a variable to store the result. Must not be NULL. | |
9b1502ef ML |
640 | * |
641 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
642 | * |
643 | * @since 0.1.0 | |
9b1502ef ML |
644 | */ |
645 | enum sp_return sp_get_config_baudrate(const struct sp_port_config *config, int *baudrate_ptr); | |
646 | ||
647 | /** | |
648 | * Set the baud rate in a port configuration. | |
649 | * | |
35578b06 UH |
650 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
651 | * @param[in] baudrate Baud rate in bits per second, or -1 to retain the current setting. | |
9b1502ef ML |
652 | * |
653 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
654 | * |
655 | * @since 0.1.0 | |
9b1502ef ML |
656 | */ |
657 | enum sp_return sp_set_config_baudrate(struct sp_port_config *config, int baudrate); | |
658 | ||
659 | /** | |
660 | * Set the data bits for the specified serial port. | |
cf9d365c | 661 | * |
35578b06 UH |
662 | * @param[in] port Pointer to a port structure. Must not be NULL. |
663 | * @param[in] bits Number of data bits. | |
cf9d365c | 664 | * |
f36c6395 | 665 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
666 | * |
667 | * @since 0.1.0 | |
cf9d365c | 668 | */ |
eb6ed20f | 669 | enum sp_return sp_set_bits(struct sp_port *port, int bits); |
cd5f5281 ML |
670 | |
671 | /** | |
9b1502ef ML |
672 | * Get the data bits from a port configuration. |
673 | * | |
35578b06 UH |
674 | * The user should allocate a variable of type int and |
675 | * pass a pointer to this to receive the result. | |
9b1502ef | 676 | * |
35578b06 UH |
677 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
678 | * @param[out] bits_ptr Pointer to a variable to store the result. Must not be NULL. | |
9b1502ef ML |
679 | * |
680 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
681 | * |
682 | * @since 0.1.0 | |
9b1502ef ML |
683 | */ |
684 | enum sp_return sp_get_config_bits(const struct sp_port_config *config, int *bits_ptr); | |
685 | ||
686 | /** | |
687 | * Set the data bits in a port configuration. | |
688 | * | |
35578b06 UH |
689 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
690 | * @param[in] bits Number of data bits, or -1 to retain the current setting. | |
9b1502ef ML |
691 | * |
692 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
693 | * |
694 | * @since 0.1.0 | |
9b1502ef ML |
695 | */ |
696 | enum sp_return sp_set_config_bits(struct sp_port_config *config, int bits); | |
697 | ||
698 | /** | |
699 | * Set the parity setting for the specified serial port. | |
cf9d365c | 700 | * |
35578b06 UH |
701 | * @param[in] port Pointer to a port structure. Must not be NULL. |
702 | * @param[in] parity Parity setting. | |
cf9d365c | 703 | * |
f36c6395 | 704 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
705 | * |
706 | * @since 0.1.0 | |
cf9d365c | 707 | */ |
eb6ed20f | 708 | enum sp_return sp_set_parity(struct sp_port *port, enum sp_parity parity); |
cd5f5281 ML |
709 | |
710 | /** | |
9b1502ef ML |
711 | * Get the parity setting from a port configuration. |
712 | * | |
35578b06 UH |
713 | * The user should allocate a variable of type enum sp_parity and |
714 | * pass a pointer to this to receive the result. | |
9b1502ef | 715 | * |
35578b06 UH |
716 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
717 | * @param[out] parity_ptr Pointer to a variable to store the result. Must not be NULL. | |
9b1502ef ML |
718 | * |
719 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
720 | * |
721 | * @since 0.1.0 | |
9b1502ef ML |
722 | */ |
723 | enum sp_return sp_get_config_parity(const struct sp_port_config *config, enum sp_parity *parity_ptr); | |
724 | ||
725 | /** | |
726 | * Set the parity setting in a port configuration. | |
727 | * | |
35578b06 UH |
728 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
729 | * @param[in] parity Parity setting, or -1 to retain the current setting. | |
9b1502ef ML |
730 | * |
731 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
732 | * |
733 | * @since 0.1.0 | |
9b1502ef ML |
734 | */ |
735 | enum sp_return sp_set_config_parity(struct sp_port_config *config, enum sp_parity parity); | |
736 | ||
737 | /** | |
738 | * Set the stop bits for the specified serial port. | |
cf9d365c | 739 | * |
35578b06 UH |
740 | * @param[in] port Pointer to a port structure. Must not be NULL. |
741 | * @param[in] stopbits Number of stop bits. | |
cf9d365c | 742 | * |
f36c6395 | 743 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
744 | * |
745 | * @since 0.1.0 | |
cf9d365c | 746 | */ |
eb6ed20f | 747 | enum sp_return sp_set_stopbits(struct sp_port *port, int stopbits); |
cd5f5281 ML |
748 | |
749 | /** | |
9b1502ef | 750 | * Get the stop bits from a port configuration. |
cf9d365c | 751 | * |
35578b06 UH |
752 | * The user should allocate a variable of type int and |
753 | * pass a pointer to this to receive the result. | |
cf9d365c | 754 | * |
35578b06 UH |
755 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
756 | * @param[out] stopbits_ptr Pointer to a variable to store the result. Must not be NULL. | |
cf9d365c | 757 | * |
f36c6395 | 758 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
759 | * |
760 | * @since 0.1.0 | |
cf9d365c | 761 | */ |
9b1502ef ML |
762 | enum sp_return sp_get_config_stopbits(const struct sp_port_config *config, int *stopbits_ptr); |
763 | ||
764 | /** | |
765 | * Set the stop bits in a port configuration. | |
766 | * | |
35578b06 UH |
767 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
768 | * @param[in] stopbits Number of stop bits, or -1 to retain the current setting. | |
9b1502ef ML |
769 | * |
770 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
771 | * |
772 | * @since 0.1.0 | |
9b1502ef ML |
773 | */ |
774 | enum sp_return sp_set_config_stopbits(struct sp_port_config *config, int stopbits); | |
18fc2dd1 | 775 | |
cd5f5281 | 776 | /** |
9b1502ef | 777 | * Set the RTS pin behaviour for the specified serial port. |
cf9d365c | 778 | * |
35578b06 UH |
779 | * @param[in] port Pointer to a port structure. Must not be NULL. |
780 | * @param[in] rts RTS pin mode. | |
cf9d365c | 781 | * |
f36c6395 | 782 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
783 | * |
784 | * @since 0.1.0 | |
cf9d365c | 785 | */ |
eb6ed20f | 786 | enum sp_return sp_set_rts(struct sp_port *port, enum sp_rts rts); |
cd5f5281 ML |
787 | |
788 | /** | |
9b1502ef ML |
789 | * Get the RTS pin behaviour from a port configuration. |
790 | * | |
35578b06 UH |
791 | * The user should allocate a variable of type enum sp_rts and |
792 | * pass a pointer to this to receive the result. | |
9b1502ef | 793 | * |
35578b06 UH |
794 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
795 | * @param[out] rts_ptr Pointer to a variable to store the result. Must not be NULL. | |
9b1502ef ML |
796 | * |
797 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
798 | * |
799 | * @since 0.1.0 | |
9b1502ef ML |
800 | */ |
801 | enum sp_return sp_get_config_rts(const struct sp_port_config *config, enum sp_rts *rts_ptr); | |
802 | ||
803 | /** | |
804 | * Set the RTS pin behaviour in a port configuration. | |
805 | * | |
35578b06 UH |
806 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
807 | * @param[in] rts RTS pin mode, or -1 to retain the current setting. | |
9b1502ef ML |
808 | * |
809 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
810 | * |
811 | * @since 0.1.0 | |
9b1502ef ML |
812 | */ |
813 | enum sp_return sp_set_config_rts(struct sp_port_config *config, enum sp_rts rts); | |
814 | ||
815 | /** | |
816 | * Set the CTS pin behaviour for the specified serial port. | |
cf9d365c | 817 | * |
35578b06 UH |
818 | * @param[in] port Pointer to a port structure. Must not be NULL. |
819 | * @param[in] cts CTS pin mode. | |
cf9d365c | 820 | * |
f36c6395 | 821 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
822 | * |
823 | * @since 0.1.0 | |
cf9d365c | 824 | */ |
eb6ed20f | 825 | enum sp_return sp_set_cts(struct sp_port *port, enum sp_cts cts); |
cd5f5281 ML |
826 | |
827 | /** | |
9b1502ef ML |
828 | * Get the CTS pin behaviour from a port configuration. |
829 | * | |
35578b06 UH |
830 | * The user should allocate a variable of type enum sp_cts and |
831 | * pass a pointer to this to receive the result. | |
9b1502ef | 832 | * |
35578b06 UH |
833 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
834 | * @param[out] cts_ptr Pointer to a variable to store the result. Must not be NULL. | |
9b1502ef ML |
835 | * |
836 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
837 | * |
838 | * @since 0.1.0 | |
9b1502ef ML |
839 | */ |
840 | enum sp_return sp_get_config_cts(const struct sp_port_config *config, enum sp_cts *cts_ptr); | |
841 | ||
842 | /** | |
843 | * Set the CTS pin behaviour in a port configuration. | |
844 | * | |
35578b06 UH |
845 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
846 | * @param[in] cts CTS pin mode, or -1 to retain the current setting. | |
9b1502ef ML |
847 | * |
848 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
849 | * |
850 | * @since 0.1.0 | |
9b1502ef ML |
851 | */ |
852 | enum sp_return sp_set_config_cts(struct sp_port_config *config, enum sp_cts cts); | |
853 | ||
854 | /** | |
855 | * Set the DTR pin behaviour for the specified serial port. | |
cf9d365c | 856 | * |
35578b06 UH |
857 | * @param[in] port Pointer to a port structure. Must not be NULL. |
858 | * @param[in] dtr DTR pin mode. | |
cf9d365c | 859 | * |
f36c6395 | 860 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
861 | * |
862 | * @since 0.1.0 | |
cf9d365c | 863 | */ |
eb6ed20f | 864 | enum sp_return sp_set_dtr(struct sp_port *port, enum sp_dtr dtr); |
cd5f5281 ML |
865 | |
866 | /** | |
9b1502ef ML |
867 | * Get the DTR pin behaviour from a port configuration. |
868 | * | |
35578b06 UH |
869 | * The user should allocate a variable of type enum sp_dtr and |
870 | * pass a pointer to this to receive the result. | |
9b1502ef | 871 | * |
35578b06 UH |
872 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
873 | * @param[out] dtr_ptr Pointer to a variable to store the result. Must not be NULL. | |
9b1502ef ML |
874 | * |
875 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
876 | * |
877 | * @since 0.1.0 | |
9b1502ef ML |
878 | */ |
879 | enum sp_return sp_get_config_dtr(const struct sp_port_config *config, enum sp_dtr *dtr_ptr); | |
880 | ||
881 | /** | |
882 | * Set the DTR pin behaviour in a port configuration. | |
883 | * | |
35578b06 UH |
884 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
885 | * @param[in] dtr DTR pin mode, or -1 to retain the current setting. | |
9b1502ef ML |
886 | * |
887 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
888 | * |
889 | * @since 0.1.0 | |
9b1502ef ML |
890 | */ |
891 | enum sp_return sp_set_config_dtr(struct sp_port_config *config, enum sp_dtr dtr); | |
892 | ||
893 | /** | |
894 | * Set the DSR pin behaviour for the specified serial port. | |
cf9d365c | 895 | * |
35578b06 UH |
896 | * @param[in] port Pointer to a port structure. Must not be NULL. |
897 | * @param[in] dsr DSR pin mode. | |
cf9d365c | 898 | * |
f36c6395 | 899 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
900 | * |
901 | * @since 0.1.0 | |
cf9d365c | 902 | */ |
eb6ed20f | 903 | enum sp_return sp_set_dsr(struct sp_port *port, enum sp_dsr dsr); |
cd5f5281 ML |
904 | |
905 | /** | |
9b1502ef ML |
906 | * Get the DSR pin behaviour from a port configuration. |
907 | * | |
35578b06 UH |
908 | * The user should allocate a variable of type enum sp_dsr and |
909 | * pass a pointer to this to receive the result. | |
9b1502ef | 910 | * |
35578b06 UH |
911 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
912 | * @param[out] dsr_ptr Pointer to a variable to store the result. Must not be NULL. | |
9b1502ef ML |
913 | * |
914 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
915 | * |
916 | * @since 0.1.0 | |
9b1502ef ML |
917 | */ |
918 | enum sp_return sp_get_config_dsr(const struct sp_port_config *config, enum sp_dsr *dsr_ptr); | |
919 | ||
920 | /** | |
921 | * Set the DSR pin behaviour in a port configuration. | |
922 | * | |
35578b06 UH |
923 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
924 | * @param[in] dsr DSR pin mode, or -1 to retain the current setting. | |
9b1502ef ML |
925 | * |
926 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
927 | * |
928 | * @since 0.1.0 | |
9b1502ef ML |
929 | */ |
930 | enum sp_return sp_set_config_dsr(struct sp_port_config *config, enum sp_dsr dsr); | |
931 | ||
932 | /** | |
933 | * Set the XON/XOFF configuration for the specified serial port. | |
cf9d365c | 934 | * |
35578b06 UH |
935 | * @param[in] port Pointer to a port structure. Must not be NULL. |
936 | * @param[in] xon_xoff XON/XOFF mode. | |
cf9d365c | 937 | * |
f36c6395 | 938 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
939 | * |
940 | * @since 0.1.0 | |
cf9d365c | 941 | */ |
eb6ed20f | 942 | enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff); |
e96d8bd2 | 943 | |
9b1502ef ML |
944 | /** |
945 | * Get the XON/XOFF configuration from a port configuration. | |
946 | * | |
35578b06 UH |
947 | * The user should allocate a variable of type enum sp_xonxoff and |
948 | * pass a pointer to this to receive the result. | |
9b1502ef | 949 | * |
35578b06 UH |
950 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
951 | * @param[out] xon_xoff_ptr Pointer to a variable to store the result. Must not be NULL. | |
9b1502ef ML |
952 | * |
953 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
954 | * |
955 | * @since 0.1.0 | |
9b1502ef ML |
956 | */ |
957 | enum sp_return sp_get_config_xon_xoff(const struct sp_port_config *config, enum sp_xonxoff *xon_xoff_ptr); | |
958 | ||
959 | /** | |
960 | * Set the XON/XOFF configuration in a port configuration. | |
961 | * | |
35578b06 UH |
962 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
963 | * @param[in] xon_xoff XON/XOFF mode, or -1 to retain the current setting. | |
9b1502ef ML |
964 | * |
965 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
966 | * |
967 | * @since 0.1.0 | |
9b1502ef ML |
968 | */ |
969 | enum sp_return sp_set_config_xon_xoff(struct sp_port_config *config, enum sp_xonxoff xon_xoff); | |
970 | ||
971 | /** | |
972 | * Set the flow control type in a port configuration. | |
973 | * | |
974 | * This function is a wrapper that sets the RTS, CTS, DTR, DSR and | |
975 | * XON/XOFF settings as necessary for the specified flow control | |
976 | * type. For more fine-grained control of these settings, use their | |
977 | * individual configuration functions. | |
978 | * | |
35578b06 UH |
979 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
980 | * @param[in] flowcontrol Flow control setting to use. | |
9b1502ef ML |
981 | * |
982 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
983 | * |
984 | * @since 0.1.0 | |
9b1502ef ML |
985 | */ |
986 | enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_flowcontrol flowcontrol); | |
987 | ||
988 | /** | |
989 | * Set the flow control type for the specified serial port. | |
990 | * | |
991 | * This function is a wrapper that sets the RTS, CTS, DTR, DSR and | |
992 | * XON/XOFF settings as necessary for the specified flow control | |
993 | * type. For more fine-grained control of these settings, use their | |
994 | * individual configuration functions. | |
995 | * | |
35578b06 UH |
996 | * @param[in] port Pointer to a port structure. Must not be NULL. |
997 | * @param[in] flowcontrol Flow control setting to use. | |
9b1502ef ML |
998 | * |
999 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
1000 | * |
1001 | * @since 0.1.0 | |
9b1502ef ML |
1002 | */ |
1003 | enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol); | |
1004 | ||
091e75fe | 1005 | /** |
cf9d365c | 1006 | * @} |
144a598f UH |
1007 | * |
1008 | * @defgroup Data Data handling | |
1009 | * | |
1010 | * Reading, writing, and flushing data. | |
1011 | * | |
cf9d365c | 1012 | * @{ |
144a598f | 1013 | */ |
091e75fe ML |
1014 | |
1015 | /** | |
2007ce5e ML |
1016 | * Read bytes from the specified serial port, blocking until complete. |
1017 | * | |
b87deb7c ML |
1018 | * @warning If your program runs on Unix, defines its own signal handlers, and |
1019 | * needs to abort blocking reads when these are called, then you | |
1020 | * should not use this function. It repeats system calls that return | |
1021 | * with EINTR. To be able to abort a read from a signal handler, you | |
1022 | * should implement your own blocking read using sp_nonblocking_read() | |
2007ce5e ML |
1023 | * together with a blocking method that makes sense for your program. |
1024 | * E.g. you can obtain the file descriptor for an open port using | |
1025 | * sp_get_port_handle() and use this to call select() or pselect(), | |
1026 | * with appropriate arrangements to return if a signal is received. | |
cf9d365c | 1027 | * |
35578b06 UH |
1028 | * @param[in] port Pointer to a port structure. Must not be NULL. |
1029 | * @param[out] buf Buffer in which to store the bytes read. Must not be NULL. | |
1030 | * @param[in] count Requested number of bytes to read. | |
1b91c6ea | 1031 | * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely. |
e3dcf906 ML |
1032 | * |
1033 | * @return The number of bytes read on success, or a negative error code. If | |
1034 | * the number of bytes returned is less than that requested, the | |
1035 | * timeout was reached before the requested number of bytes was | |
1036 | * available. If timeout is zero, the function will always return | |
1037 | * either the requested number of bytes or a negative error code. | |
1652aa86 UH |
1038 | * |
1039 | * @since 0.1.0 | |
e3dcf906 | 1040 | */ |
1b91c6ea | 1041 | enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout_ms); |
e3dcf906 ML |
1042 | |
1043 | /** | |
1044 | * Read bytes from the specified serial port, without blocking. | |
cf9d365c | 1045 | * |
35578b06 UH |
1046 | * @param[in] port Pointer to a port structure. Must not be NULL. |
1047 | * @param[out] buf Buffer in which to store the bytes read. Must not be NULL. | |
1048 | * @param[in] count Maximum number of bytes to read. | |
cf9d365c | 1049 | * |
e3dcf906 ML |
1050 | * @return The number of bytes read on success, or a negative error code. The |
1051 | * number of bytes returned may be any number from zero to the maximum | |
1052 | * that was requested. | |
1652aa86 UH |
1053 | * |
1054 | * @since 0.1.0 | |
e3dcf906 ML |
1055 | */ |
1056 | enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count); | |
1057 | ||
1058 | /** | |
1059 | * Write bytes to the specified serial port, blocking until complete. | |
1060 | * | |
1061 | * Note that this function only ensures that the accepted bytes have been | |
1062 | * written to the OS; they may be held in driver or hardware buffers and not | |
1063 | * yet physically transmitted. To check whether all written bytes have actually | |
1064 | * been transmitted, use the sp_output_waiting() function. To wait until all | |
1065 | * written bytes have actually been transmitted, use the sp_drain() function. | |
1066 | * | |
b87deb7c ML |
1067 | * @warning If your program runs on Unix, defines its own signal handlers, and |
1068 | * needs to abort blocking writes when these are called, then you | |
1069 | * should not use this function. It repeats system calls that return | |
1070 | * with EINTR. To be able to abort a write from a signal handler, you | |
1071 | * should implement your own blocking write using sp_nonblocking_write() | |
2007ce5e ML |
1072 | * together with a blocking method that makes sense for your program. |
1073 | * E.g. you can obtain the file descriptor for an open port using | |
1074 | * sp_get_port_handle() and use this to call select() or pselect(), | |
1075 | * with appropriate arrangements to return if a signal is received. | |
1076 | * | |
35578b06 UH |
1077 | * @param[in] port Pointer to a port structure. Must not be NULL. |
1078 | * @param[in] buf Buffer containing the bytes to write. Must not be NULL. | |
1079 | * @param[in] count Requested number of bytes to write. | |
1b91c6ea | 1080 | * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely. |
e3dcf906 | 1081 | * |
85987464 ML |
1082 | * @return The number of bytes written on success, or a negative error code. |
1083 | * If the number of bytes returned is less than that requested, the | |
e3dcf906 | 1084 | * timeout was reached before the requested number of bytes was |
85987464 | 1085 | * written. If timeout is zero, the function will always return |
e3dcf906 ML |
1086 | * either the requested number of bytes or a negative error code. In |
1087 | * the event of an error there is no way to determine how many bytes | |
cfa5af67 | 1088 | * were sent before the error occurred. |
1652aa86 UH |
1089 | * |
1090 | * @since 0.1.0 | |
cf9d365c | 1091 | */ |
1b91c6ea | 1092 | enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout_ms); |
091e75fe ML |
1093 | |
1094 | /** | |
e3dcf906 | 1095 | * Write bytes to the specified serial port, without blocking. |
cf9d365c | 1096 | * |
e3dcf906 ML |
1097 | * Note that this function only ensures that the accepted bytes have been |
1098 | * written to the OS; they may be held in driver or hardware buffers and not | |
1099 | * yet physically transmitted. To check whether all written bytes have actually | |
1100 | * been transmitted, use the sp_output_waiting() function. To wait until all | |
1101 | * written bytes have actually been transmitted, use the sp_drain() function. | |
cf9d365c | 1102 | * |
35578b06 UH |
1103 | * @param[in] port Pointer to a port structure. Must not be NULL. |
1104 | * @param[in] buf Buffer containing the bytes to write. Must not be NULL. | |
1105 | * @param[in] count Maximum number of bytes to write. | |
cf9d365c | 1106 | * |
f36c6395 | 1107 | * @return The number of bytes written on success, or a negative error code. |
e3dcf906 ML |
1108 | * The number of bytes returned may be any number from zero to the |
1109 | * maximum that was requested. | |
1652aa86 UH |
1110 | * |
1111 | * @since 0.1.0 | |
cf9d365c | 1112 | */ |
e3dcf906 | 1113 | enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_t count); |
091e75fe | 1114 | |
3353c22f ML |
1115 | /** |
1116 | * Gets the number of bytes waiting in the input buffer. | |
1117 | * | |
35578b06 | 1118 | * @param[in] port Pointer to a port structure. Must not be NULL. |
3353c22f ML |
1119 | * |
1120 | * @return Number of bytes waiting on success, a negative error code otherwise. | |
1652aa86 UH |
1121 | * |
1122 | * @since 0.1.0 | |
3353c22f ML |
1123 | */ |
1124 | enum sp_return sp_input_waiting(struct sp_port *port); | |
1125 | ||
1126 | /** | |
1127 | * Gets the number of bytes waiting in the output buffer. | |
1128 | * | |
35578b06 | 1129 | * @param[in] port Pointer to a port structure. Must not be NULL. |
3353c22f ML |
1130 | * |
1131 | * @return Number of bytes waiting on success, a negative error code otherwise. | |
1652aa86 UH |
1132 | * |
1133 | * @since 0.1.0 | |
3353c22f ML |
1134 | */ |
1135 | enum sp_return sp_output_waiting(struct sp_port *port); | |
1136 | ||
091e75fe | 1137 | /** |
fd8fd11a ML |
1138 | * Flush serial port buffers. Data in the selected buffer(s) is discarded. |
1139 | * | |
35578b06 UH |
1140 | * @param[in] port Pointer to a port structure. Must not be NULL. |
1141 | * @param[in] buffers Which buffer(s) to flush. | |
cf9d365c | 1142 | * |
f36c6395 | 1143 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
1144 | * |
1145 | * @since 0.1.0 | |
cf9d365c | 1146 | */ |
fd8fd11a | 1147 | enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers); |
091e75fe | 1148 | |
69a3739c ML |
1149 | /** |
1150 | * Wait for buffered data to be transmitted. | |
1151 | * | |
2c827b21 ML |
1152 | * @warning If your program runs on Unix, defines its own signal handlers, and |
1153 | * needs to abort draining the output buffer when when these are | |
1154 | * called, then you should not use this function. It repeats system | |
1155 | * calls that return with EINTR. To be able to abort a drain from a | |
1156 | * signal handler, you would need to implement your own blocking | |
1157 | * drain by polling the result of sp_output_waiting(). | |
1158 | * | |
35578b06 | 1159 | * @param[in] port Pointer to a port structure. Must not be NULL. |
3f099f4f | 1160 | * |
f36c6395 | 1161 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
1162 | * |
1163 | * @since 0.1.0 | |
69a3739c ML |
1164 | */ |
1165 | enum sp_return sp_drain(struct sp_port *port); | |
1166 | ||
6f1186aa ML |
1167 | /** |
1168 | * @} | |
144a598f UH |
1169 | * |
1170 | * @defgroup Waiting Waiting | |
1171 | * | |
1172 | * Waiting for events and timeout handling. | |
1173 | * | |
6f1186aa ML |
1174 | * @{ |
1175 | */ | |
1176 | ||
1177 | /** | |
1178 | * Allocate storage for a set of events. | |
1179 | * | |
1180 | * The user should allocate a variable of type struct sp_event_set *, | |
1181 | * then pass a pointer to this variable to receive the result. | |
1182 | * | |
1183 | * The result should be freed after use by calling sp_free_event_set(). | |
1184 | * | |
35578b06 UH |
1185 | * @param[out] result_ptr If any error is returned, the variable pointed to by |
1186 | * result_ptr will be set to NULL. Otherwise, it will | |
1187 | * be set to point to the event set. Must not be NULL. | |
1188 | * | |
6f1186aa | 1189 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
1190 | * |
1191 | * @since 0.1.0 | |
6f1186aa ML |
1192 | */ |
1193 | enum sp_return sp_new_event_set(struct sp_event_set **result_ptr); | |
1194 | ||
1195 | /** | |
1196 | * Add events to a struct sp_event_set for a given port. | |
1197 | * | |
1198 | * The port must first be opened by calling sp_open() using the same port | |
1199 | * structure. | |
1200 | * | |
1201 | * After the port is closed or the port structure freed, the results may | |
1202 | * no longer be valid. | |
1203 | * | |
35578b06 UH |
1204 | * @param[in,out] event_set Event set to update. Must not be NULL. |
1205 | * @param[in] port Pointer to a port structure. Must not be NULL. | |
1206 | * @param[in] mask Bitmask of events to be waited for. | |
6f1186aa ML |
1207 | * |
1208 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
1209 | * |
1210 | * @since 0.1.0 | |
6f1186aa ML |
1211 | */ |
1212 | enum sp_return sp_add_port_events(struct sp_event_set *event_set, | |
1213 | const struct sp_port *port, enum sp_event mask); | |
1214 | ||
1215 | /** | |
1216 | * Wait for any of a set of events to occur. | |
1217 | * | |
35578b06 | 1218 | * @param[in] event_set Event set to wait on. Must not be NULL. |
1b91c6ea | 1219 | * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely. |
6f1186aa ML |
1220 | * |
1221 | * @return SP_OK upon success, a negative error code otherwise. | |
1652aa86 UH |
1222 | * |
1223 | * @since 0.1.0 | |
6f1186aa | 1224 | */ |
1b91c6ea | 1225 | enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout_ms); |
6f1186aa ML |
1226 | |
1227 | /** | |
1228 | * Free a structure allocated by sp_new_event_set(). | |
1652aa86 | 1229 | * |
35578b06 UH |
1230 | * @param[in] event_set Event set to free. Must not be NULL. |
1231 | * | |
1652aa86 | 1232 | * @since 0.1.0 |
6f1186aa ML |
1233 | */ |
1234 | void sp_free_event_set(struct sp_event_set *event_set); | |
1235 | ||
90cc3ee6 ML |
1236 | /** |
1237 | * @} | |
144a598f UH |
1238 | * |
1239 | * @defgroup Signals Signals | |
1240 | * | |
1241 | * Port signalling operations. | |
1242 | * | |
90cc3ee6 ML |
1243 | * @{ |
1244 | */ | |
1245 | ||
8cf7c697 ML |
1246 | /** |
1247 | * Gets the status of the control signals for the specified port. | |
1248 | * | |
1249 | * The user should allocate a variable of type "enum sp_signal" and pass a | |
1250 | * pointer to this variable to receive the result. The result is a bitmask | |
1251 | * in which individual signals can be checked by bitwise OR with values of | |
1252 | * the sp_signal enum. | |
1253 | * | |
35578b06 UH |
1254 | * @param[in] port Pointer to a port structure. Must not be NULL. |
1255 | * @param[out] signal_mask Pointer to a variable to receive the result. | |
1256 | * Must not be NULL. | |
8cf7c697 | 1257 | * |
f36c6395 | 1258 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
1259 | * |
1260 | * @since 0.1.0 | |
8cf7c697 | 1261 | */ |
f3ccf157 | 1262 | enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signal_mask); |
8cf7c697 | 1263 | |
90cc3ee6 ML |
1264 | /** |
1265 | * Put the port transmit line into the break state. | |
1266 | * | |
35578b06 | 1267 | * @param[in] port Pointer to a port structure. Must not be NULL. |
3f099f4f | 1268 | * |
f36c6395 | 1269 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
1270 | * |
1271 | * @since 0.1.0 | |
90cc3ee6 ML |
1272 | */ |
1273 | enum sp_return sp_start_break(struct sp_port *port); | |
1274 | ||
1275 | /** | |
1276 | * Take the port transmit line out of the break state. | |
1277 | * | |
35578b06 | 1278 | * @param[in] port Pointer to a port structure. Must not be NULL. |
3f099f4f | 1279 | * |
f36c6395 | 1280 | * @return SP_OK upon success, a negative error code otherwise. |
1652aa86 UH |
1281 | * |
1282 | * @since 0.1.0 | |
90cc3ee6 ML |
1283 | */ |
1284 | enum sp_return sp_end_break(struct sp_port *port); | |
1285 | ||
091e75fe | 1286 | /** |
cf9d365c | 1287 | * @} |
144a598f UH |
1288 | * |
1289 | * @defgroup Errors Errors | |
1290 | * | |
1291 | * Obtaining error information. | |
1292 | * | |
cf9d365c | 1293 | * @{ |
144a598f | 1294 | */ |
091e75fe | 1295 | |
cd5f5281 | 1296 | /** |
cf9d365c UH |
1297 | * Get the error code for a failed operation. |
1298 | * | |
1299 | * In order to obtain the correct result, this function should be called | |
1300 | * straight after the failure, before executing any other system operations. | |
1301 | * | |
1302 | * @return The system's numeric code for the error that caused the last | |
1303 | * operation to fail. | |
1652aa86 UH |
1304 | * |
1305 | * @since 0.1.0 | |
cf9d365c | 1306 | */ |
74510d4b | 1307 | int sp_last_error_code(void); |
cd5f5281 ML |
1308 | |
1309 | /** | |
cf9d365c UH |
1310 | * Get the error message for a failed operation. |
1311 | * | |
1312 | * In order to obtain the correct result, this function should be called | |
1313 | * straight after the failure, before executing other system operations. | |
1314 | * | |
1315 | * @return The system's message for the error that caused the last | |
1316 | * operation to fail. This string may be allocated by the function, | |
1317 | * and should be freed after use by calling sp_free_error_message(). | |
1652aa86 UH |
1318 | * |
1319 | * @since 0.1.0 | |
cf9d365c | 1320 | */ |
74510d4b | 1321 | char *sp_last_error_message(void); |
cd5f5281 ML |
1322 | |
1323 | /** | |
cf9d365c | 1324 | * Free an error message returned by sp_last_error_message(). |
1652aa86 | 1325 | * |
35578b06 UH |
1326 | * @param[in] message The error message string to free. Must not be NULL. |
1327 | * | |
1652aa86 | 1328 | * @since 0.1.0 |
cf9d365c | 1329 | */ |
74510d4b | 1330 | void sp_free_error_message(char *message); |
e8ffaee9 | 1331 | |
863b35e6 ML |
1332 | /** |
1333 | * Set the handler function for library debugging messages. | |
1334 | * | |
1335 | * Debugging messages are generated by the library during each operation, | |
1336 | * to help in diagnosing problems. The handler will be called for each | |
1337 | * message. The handler can be set to NULL to ignore all debug messages. | |
1338 | * | |
1339 | * The handler function should accept a format string and variable length | |
1340 | * argument list, in the same manner as e.g. printf(). | |
1341 | * | |
1342 | * The default handler is sp_default_debug_handler(). | |
1652aa86 | 1343 | * |
35578b06 UH |
1344 | * @param[in] handler The handler function to use. Can be NULL (in that case |
1345 | * all debug messages will be ignored). | |
1346 | * | |
1652aa86 | 1347 | * @since 0.1.0 |
863b35e6 ML |
1348 | */ |
1349 | void sp_set_debug_handler(void (*handler)(const char *format, ...)); | |
1350 | ||
1351 | /** | |
1352 | * Default handler function for library debugging messages. | |
1353 | * | |
1354 | * This function prints debug messages to the standard error stream if the | |
1355 | * environment variable LIBSERIALPORT_DEBUG is set. Otherwise, they are | |
1356 | * ignored. | |
1652aa86 | 1357 | * |
35578b06 UH |
1358 | * @param[in] format The format string to use. Must not be NULL. |
1359 | * @param[in] ... The variable length argument list to use. | |
1360 | * | |
1652aa86 | 1361 | * @since 0.1.0 |
863b35e6 ML |
1362 | */ |
1363 | void sp_default_debug_handler(const char *format, ...); | |
1364 | ||
cf9d365c | 1365 | /** @} */ |
091e75fe | 1366 | |
524b0e14 | 1367 | /** |
144a598f UH |
1368 | * @defgroup Versions Versions |
1369 | * | |
1370 | * Version number querying functions, definitions, and macros. | |
524b0e14 UH |
1371 | * |
1372 | * This set of API calls returns two different version numbers related | |
1373 | * to libserialport. The "package version" is the release version number of the | |
1374 | * libserialport tarball in the usual "major.minor.micro" format, e.g. "0.1.0". | |
1375 | * | |
1376 | * The "library version" is independent of that; it is the libtool version | |
1377 | * number in the "current:revision:age" format, e.g. "2:0:0". | |
1378 | * See http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning for details. | |
1379 | * | |
1380 | * Both version numbers (and/or individual components of them) can be | |
1381 | * retrieved via the API calls at runtime, and/or they can be checked at | |
1382 | * compile/preprocessor time using the respective macros. | |
1383 | * | |
1384 | * @{ | |
1385 | */ | |
1386 | ||
1387 | /* | |
1388 | * Package version macros (can be used for conditional compilation). | |
1389 | */ | |
1390 | ||
1391 | /** The libserialport package 'major' version number. */ | |
1392 | #define SP_PACKAGE_VERSION_MAJOR @SP_PACKAGE_VERSION_MAJOR@ | |
1393 | ||
1394 | /** The libserialport package 'minor' version number. */ | |
1395 | #define SP_PACKAGE_VERSION_MINOR @SP_PACKAGE_VERSION_MINOR@ | |
1396 | ||
1397 | /** The libserialport package 'micro' version number. */ | |
1398 | #define SP_PACKAGE_VERSION_MICRO @SP_PACKAGE_VERSION_MICRO@ | |
1399 | ||
1400 | /** The libserialport package version ("major.minor.micro") as string. */ | |
1401 | #define SP_PACKAGE_VERSION_STRING "@SP_PACKAGE_VERSION@" | |
1402 | ||
1403 | /* | |
1404 | * Library/libtool version macros (can be used for conditional compilation). | |
1405 | */ | |
1406 | ||
1407 | /** The libserialport libtool 'current' version number. */ | |
1408 | #define SP_LIB_VERSION_CURRENT @SP_LIB_VERSION_CURRENT@ | |
1409 | ||
1410 | /** The libserialport libtool 'revision' version number. */ | |
1411 | #define SP_LIB_VERSION_REVISION @SP_LIB_VERSION_REVISION@ | |
1412 | ||
1413 | /** The libserialport libtool 'age' version number. */ | |
1414 | #define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@ | |
1415 | ||
1416 | /** The libserialport libtool version ("current:revision:age") as string. */ | |
1417 | #define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@" | |
1418 | ||
1419 | /** | |
1420 | * Get the major libserialport package version number. | |
1421 | * | |
1422 | * @return The major package version number. | |
1423 | * | |
1424 | * @since 0.1.0 | |
1425 | */ | |
1426 | int sp_get_major_package_version(void); | |
1427 | ||
1428 | /** | |
1429 | * Get the minor libserialport package version number. | |
1430 | * | |
1431 | * @return The minor package version number. | |
1432 | * | |
1433 | * @since 0.1.0 | |
1434 | */ | |
1435 | int sp_get_minor_package_version(void); | |
1436 | ||
1437 | /** | |
1438 | * Get the micro libserialport package version number. | |
1439 | * | |
1440 | * @return The micro package version number. | |
1441 | * | |
1442 | * @since 0.1.0 | |
1443 | */ | |
1444 | int sp_get_micro_package_version(void); | |
1445 | ||
1446 | /** | |
1447 | * Get the libserialport package version number as a string. | |
1448 | * | |
1449 | * @return The package version number string. The returned string is | |
1450 | * static and thus should NOT be free'd by the caller. | |
1451 | * | |
1452 | * @since 0.1.0 | |
1453 | */ | |
1454 | const char *sp_get_package_version_string(void); | |
1455 | ||
1456 | /** | |
1457 | * Get the "current" part of the libserialport library version number. | |
1458 | * | |
1459 | * @return The "current" library version number. | |
1460 | * | |
1461 | * @since 0.1.0 | |
1462 | */ | |
1463 | int sp_get_current_lib_version(void); | |
1464 | ||
1465 | /** | |
1466 | * Get the "revision" part of the libserialport library version number. | |
1467 | * | |
1468 | * @return The "revision" library version number. | |
1469 | * | |
1470 | * @since 0.1.0 | |
1471 | */ | |
1472 | int sp_get_revision_lib_version(void); | |
1473 | ||
1474 | /** | |
1475 | * Get the "age" part of the libserialport library version number. | |
1476 | * | |
1477 | * @return The "age" library version number. | |
1478 | * | |
1479 | * @since 0.1.0 | |
1480 | */ | |
1481 | int sp_get_age_lib_version(void); | |
1482 | ||
1483 | /** | |
1484 | * Get the libserialport library version number as a string. | |
1485 | * | |
1486 | * @return The library version number string. The returned string is | |
1487 | * static and thus should NOT be free'd by the caller. | |
1488 | * | |
1489 | * @since 0.1.0 | |
1490 | */ | |
1491 | const char *sp_get_lib_version_string(void); | |
1492 | ||
1493 | /** @} */ | |
1494 | ||
5ef8a1ed UH |
1495 | #ifdef __cplusplus |
1496 | } | |
1497 | #endif | |
1498 | ||
8645feda | 1499 | #endif |