#endif
#include <stddef.h>
-#ifdef _WIN32
-#include <windows.h>
-#endif
/** Return values. */
enum sp_return {
SP_OK = 0,
/** Invalid arguments were passed to the function. */
SP_ERR_ARG = -1,
- /** A system error occured while executing the operation. */
+ /** A system error occurred while executing the operation. */
SP_ERR_FAIL = -2,
/** A memory allocation failed while executing the operation. */
SP_ERR_MEM = -3,
/** The requested operation is not supported by this system or device. */
- SP_ERR_SUPP = -4,
+ SP_ERR_SUPP = -4
};
/** Port access modes. */
SP_MODE_READ = 1,
/** Open port for write access. */
SP_MODE_WRITE = 2,
+ /** Open port for read and write access. @since 0.1.1 */
+ SP_MODE_READ_WRITE = 3
};
/** Port events. */
enum sp_event {
- /* Data received and ready to read. */
+ /** Data received and ready to read. */
SP_EVENT_RX_READY = 1,
- /* Ready to transmit new data. */
+ /** Ready to transmit new data. */
SP_EVENT_TX_READY = 2,
- /* Error occured. */
- SP_EVENT_ERROR = 4,
+ /** Error occurred. */
+ SP_EVENT_ERROR = 4
};
/** Buffer selection. */
/** Output buffer. */
SP_BUF_OUTPUT = 2,
/** Both buffers. */
- SP_BUF_BOTH = 3,
+ SP_BUF_BOTH = 3
};
/** Parity settings. */
/** Mark parity. */
SP_PARITY_MARK = 3,
/** Space parity. */
- SP_PARITY_SPACE = 4,
+ SP_PARITY_SPACE = 4
};
/** RTS pin behaviour. */
/** RTS on. */
SP_RTS_ON = 1,
/** RTS used for flow control. */
- SP_RTS_FLOW_CONTROL = 2,
+ SP_RTS_FLOW_CONTROL = 2
};
/** CTS pin behaviour. */
/** CTS ignored. */
SP_CTS_IGNORE = 0,
/** CTS used for flow control. */
- SP_CTS_FLOW_CONTROL = 1,
+ SP_CTS_FLOW_CONTROL = 1
};
/** DTR pin behaviour. */
/** DTR on. */
SP_DTR_ON = 1,
/** DTR used for flow control. */
- SP_DTR_FLOW_CONTROL = 2,
+ SP_DTR_FLOW_CONTROL = 2
};
/** DSR pin behaviour. */
/** DSR ignored. */
SP_DSR_IGNORE = 0,
/** DSR used for flow control. */
- SP_DSR_FLOW_CONTROL = 1,
+ SP_DSR_FLOW_CONTROL = 1
};
/** XON/XOFF flow control behaviour. */
/** XON/XOFF enabled for output only. */
SP_XONXOFF_OUT = 2,
/** XON/XOFF enabled for input and output. */
- SP_XONXOFF_INOUT = 3,
+ SP_XONXOFF_INOUT = 3
};
/** Standard flow control combinations. */
/** Hardware flow control using RTS/CTS signals. */
SP_FLOWCONTROL_RTSCTS = 2,
/** Hardware flow control using DTR/DSR signals. */
- SP_FLOWCONTROL_DTRDSR = 3,
+ SP_FLOWCONTROL_DTRDSR = 3
};
/** Input signals. */
/** Data carrier detect. */
SP_SIG_DCD = 4,
/** Ring indicator. */
- SP_SIG_RI = 8,
+ SP_SIG_RI = 8
};
-/** Transport types. */
+/**
+ * Transport types.
+ *
+ * @since 0.1.1
+ */
enum sp_transport {
- /** Native platform serial port. */
+ /** Native platform serial port. @since 0.1.1 */
SP_TRANSPORT_NATIVE,
- /** USB serial port adapter. */
+ /** USB serial port adapter. @since 0.1.1 */
SP_TRANSPORT_USB,
- /** Bluetooh serial port adapter. */
- SP_TRANSPORT_BLUETOOTH,
+ /** Bluetooth serial port adapter. @since 0.1.1 */
+ SP_TRANSPORT_BLUETOOTH
};
/**
};
/**
-@defgroup Enumeration Port enumeration
-@{
-*/
+ * @defgroup Enumeration Port enumeration
+ *
+ * Enumerating the serial ports of a system.
+ *
+ * @{
+ */
/**
* Obtain a pointer to a new sp_port structure representing the named port.
*
* The result should be freed after use by calling sp_free_port().
*
- * If any error is returned, the variable pointed to by port_ptr will be set
- * to NULL. Otherwise, it will be set to point to the newly allocated port.
+ * @param[in] portname The OS-specific name of a serial port. Must not be NULL.
+ * @param[out] port_ptr If any error is returned, the variable pointed to by
+ * port_ptr will be set to NULL. Otherwise, it will be set
+ * to point to the newly allocated port. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Free a port structure obtained from sp_get_port_by_name() or sp_copy_port().
*
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ *
* @since 0.1.0
*/
void sp_free_port(struct sp_port *port);
* If a port from the list is to be used after freeing the list, it must be
* copied first using sp_copy_port().
*
- * If any error is returned, the variable pointed to by list_ptr will be set
- * to NULL. Otherwise, it will be set to point to the newly allocated array.
+ * @param[out] list_ptr If any error is returned, the variable pointed to by
+ * list_ptr will be set to NULL. Otherwise, it will be set
+ * to point to the newly allocated array. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
enum sp_return sp_list_ports(struct sp_port ***list_ptr);
/**
- * Make a new copy of a sp_port structure.
+ * Make a new copy of an sp_port structure.
*
* The user should allocate a variable of type "struct sp_port *" and pass a
* pointer to this to receive the result.
*
* The copy should be freed after use by calling sp_free_port().
*
- * If any error is returned, the variable pointed to by copy_ptr will be set
- * to NULL. Otherwise, it will be set to point to the newly allocated copy.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] copy_ptr If any error is returned, the variable pointed to by
+ * copy_ptr will be set to NULL. Otherwise, it will be set
+ * to point to the newly allocated copy. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
* This will also free all the sp_port structures referred to from the list;
* any that are to be retained must be copied first using sp_copy_port().
*
+ * @param[in] ports Pointer to a list of port structures. Must not be NULL.
+ *
* @since 0.1.0
*/
void sp_free_port_list(struct sp_port **ports);
/**
* @}
- * @defgroup Ports Opening, closing and querying ports
+ * @defgroup Ports Port handling
+ *
+ * Opening, closing and querying ports.
+ *
* @{
*/
/**
* Open the specified serial port.
*
- * @param port Pointer to port structure.
- * @param flags Flags to use when opening the serial port.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] flags Flags to use when opening the serial port.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Close the specified serial port.
*
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ *
* @return SP_OK upon success, a negative error code otherwise.
*
* @since 0.1.0
* current operating system; e.g. for Windows it will usually be a "COMn"
* device name, and for Unix it will be a device path beginning with "/dev/".
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return The port name, or NULL if an invalid port is passed. The name
- * string is part of the port structure and may not be used after the
- * port structure has been freed.
+ * string is part of the port structure and may not be used after
+ * the port structure has been freed.
*
* @since 0.1.0
*/
/**
* Get a description for a port, to present to end user.
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return The port description, or NULL if an invalid port is passed.
- * The description string is part of the port structure and may not be used
- * after the port structure has been freed.
+ * The description string is part of the port structure and may not
+ * be used after the port structure has been freed.
*
- * @since 0.2.0
+ * @since 0.1.1
*/
-char *sp_get_port_description(struct sp_port *port);
+char *sp_get_port_description(const struct sp_port *port);
/**
* Get the transport type used by a port.
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return The port transport type.
*
- * @since 0.2.0
+ * @since 0.1.1
*/
-enum sp_transport sp_get_port_transport(struct sp_port *port);
+enum sp_transport sp_get_port_transport(const struct sp_port *port);
/**
* Get the USB bus number and address on bus of a USB serial adapter port.
*
- * @param port Pointer to port structure.
- * @param usb_bus Pointer to variable to store USB bus.
- * @param usb_address Pointer to variable to store USB address
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] usb_bus Pointer to a variable to store the USB bus. Must not be NULL.
+ * @param[out] usb_address Pointer to a variable to store the USB address. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
- * @since 0.2.0
+ * @since 0.1.1
*/
enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
int *usb_bus, int *usb_address);
/**
* Get the USB Vendor ID and Product ID of a USB serial adapter port.
*
- * @param port Pointer to port structure.
- * @param usb_vid Pointer to variable to store USB VID.
- * @param usb_pid Pointer to variable to store USB PID
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] usb_vid Pointer to a variable to store the USB VID. Must not be NULL.
+ * @param[out] usb_pid Pointer to a variable to store the USB PID. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
- * @since 0.2.0
+ * @since 0.1.1
*/
enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, int *usb_vid, int *usb_pid);
/**
* Get the USB manufacturer string of a USB serial adapter port.
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return The port manufacturer string, or NULL if an invalid port is passed.
- * The manufacturer string is part of the port structure and may not be used
- * after the port structure has been freed.
+ * The manufacturer string is part of the port structure and may not
+ * be used after the port structure has been freed.
*
- * @since 0.2.0
+ * @since 0.1.1
*/
char *sp_get_port_usb_manufacturer(const struct sp_port *port);
/**
* Get the USB product string of a USB serial adapter port.
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return The port product string, or NULL if an invalid port is passed.
- * The product string is part of the port structure and may not be used
- * after the port structure has been freed.
+ * The product string is part of the port structure and may not be
+ * used after the port structure has been freed.
*
- * @since 0.2.0
+ * @since 0.1.1
*/
char *sp_get_port_usb_product(const struct sp_port *port);
/**
* Get the USB serial number string of a USB serial adapter port.
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return The port serial number, or NULL if an invalid port is passed.
- * The serial number string is part of the port structure and may not be used
- * after the port structure has been freed.
+ * The serial number string is part of the port structure and may
+ * not be used after the port structure has been freed.
*
- * @since 0.2.0
+ * @since 0.1.1
*/
char *sp_get_port_usb_serial(const struct sp_port *port);
/**
* Get the MAC address of a Bluetooth serial adapter port.
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return The port MAC address, or NULL if an invalid port is passed.
- * The MAC address string is part of the port structure and may not be used
- * after the port structure has been freed.
+ * The MAC address string is part of the port structure and may not
+ * be used after the port structure has been freed.
*
- * @since 0.2.0
+ * @since 0.1.1
*/
char *sp_get_port_bluetooth_address(const struct sp_port *port);
* that direct usage of the OS handle will not conflict with the
* library's own usage of the port. Be careful.
*
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] result_ptr If any error is returned, the variable pointed to by
+ * result_ptr will be set to NULL. Otherwise, it will
+ * be set to point to the OS handle. Must not be NULL.
+ *
* @return SP_OK upon success, a negative error code otherwise.
*
* @since 0.1.0
/**
* @}
- * @defgroup Configuration Setting port parameters
+ *
+ * @defgroup Configuration Configuration
+ *
+ * Setting and querying serial port parameters.
* @{
*/
*
* The structure should be freed after use by calling sp_free_config().
*
- * @param config_ptr Pointer to variable to receive result.
+ * @param[out] config_ptr Pointer to a variable to receive the result.
+ * Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Free a port configuration structure.
*
- * @param config Pointer to configuration structure.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
*
* @since 0.1.0
*/
* supported by libserialport, will be set to special values that are
* ignored by sp_set_config().
*
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] config Pointer to a configuration structure that will hold
+ * the result. Must not be NULL.
+ *
* @return SP_OK upon success, a negative error code otherwise.
*
* @since 0.1.0
* -1, but see the documentation for each field). These values will be ignored
* and the corresponding setting left unchanged on the port.
*
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ *
* @return SP_OK upon success, a negative error code otherwise.
*
* @since 0.1.0
/**
* Set the baud rate for the specified serial port.
*
- * @param port Pointer to port structure.
- * @param baudrate Baud rate in bits per second.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] baudrate Baud rate in bits per second.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Get the baud rate from a port configuration.
*
- * The user should allocate a variable of type int and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type int and
+ * pass a pointer to this to receive the result.
*
- * @param config Pointer to configuration structure.
- * @param baudrate_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] baudrate_ptr Pointer to a variable to store the result. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the baud rate in a port configuration.
*
- * @param config Pointer to configuration structure.
- * @param baudrate Baud rate in bits per second, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] baudrate Baud rate in bits per second, or -1 to retain the current setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the data bits for the specified serial port.
*
- * @param port Pointer to port structure.
- * @param bits Number of data bits.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] bits Number of data bits.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Get the data bits from a port configuration.
*
- * The user should allocate a variable of type int and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type int and
+ * pass a pointer to this to receive the result.
*
- * @param config Pointer to configuration structure.
- * @param bits_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] bits_ptr Pointer to a variable to store the result. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the data bits in a port configuration.
*
- * @param config Pointer to configuration structure.
- * @param bits Number of data bits, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] bits Number of data bits, or -1 to retain the current setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the parity setting for the specified serial port.
*
- * @param port Pointer to port structure.
- * @param parity Parity setting.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] parity Parity setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Get the parity setting from a port configuration.
*
- * The user should allocate a variable of type enum sp_parity and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_parity and
+ * pass a pointer to this to receive the result.
*
- * @param config Pointer to configuration structure.
- * @param parity_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] parity_ptr Pointer to a variable to store the result. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the parity setting in a port configuration.
*
- * @param config Pointer to configuration structure.
- * @param parity Parity setting, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] parity Parity setting, or -1 to retain the current setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the stop bits for the specified serial port.
*
- * @param port Pointer to port structure.
- * @param stopbits Number of stop bits.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] stopbits Number of stop bits.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Get the stop bits from a port configuration.
*
- * The user should allocate a variable of type int and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type int and
+ * pass a pointer to this to receive the result.
*
- * @param config Pointer to configuration structure.
- * @param stopbits_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] stopbits_ptr Pointer to a variable to store the result. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the stop bits in a port configuration.
*
- * @param config Pointer to configuration structure.
- * @param stopbits Number of stop bits, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] stopbits Number of stop bits, or -1 to retain the current setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the RTS pin behaviour for the specified serial port.
*
- * @param port Pointer to port structure.
- * @param rts RTS pin mode.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] rts RTS pin mode.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Get the RTS pin behaviour from a port configuration.
*
- * The user should allocate a variable of type enum sp_rts and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_rts and
+ * pass a pointer to this to receive the result.
*
- * @param config Pointer to configuration structure.
- * @param rts_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] rts_ptr Pointer to a variable to store the result. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the RTS pin behaviour in a port configuration.
*
- * @param config Pointer to configuration structure.
- * @param rts RTS pin mode, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] rts RTS pin mode, or -1 to retain the current setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the CTS pin behaviour for the specified serial port.
*
- * @param port Pointer to port structure.
- * @param cts CTS pin mode.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] cts CTS pin mode.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Get the CTS pin behaviour from a port configuration.
*
- * The user should allocate a variable of type enum sp_cts and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_cts and
+ * pass a pointer to this to receive the result.
*
- * @param config Pointer to configuration structure.
- * @param cts_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] cts_ptr Pointer to a variable to store the result. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the CTS pin behaviour in a port configuration.
*
- * @param config Pointer to configuration structure.
- * @param cts CTS pin mode, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] cts CTS pin mode, or -1 to retain the current setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the DTR pin behaviour for the specified serial port.
*
- * @param port Pointer to port structure.
- * @param dtr DTR pin mode.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] dtr DTR pin mode.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Get the DTR pin behaviour from a port configuration.
*
- * The user should allocate a variable of type enum sp_dtr and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_dtr and
+ * pass a pointer to this to receive the result.
*
- * @param config Pointer to configuration structure.
- * @param dtr_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] dtr_ptr Pointer to a variable to store the result. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the DTR pin behaviour in a port configuration.
*
- * @param config Pointer to configuration structure.
- * @param dtr DTR pin mode, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] dtr DTR pin mode, or -1 to retain the current setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the DSR pin behaviour for the specified serial port.
*
- * @param port Pointer to port structure.
- * @param dsr DSR pin mode.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] dsr DSR pin mode.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Get the DSR pin behaviour from a port configuration.
*
- * The user should allocate a variable of type enum sp_dsr and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_dsr and
+ * pass a pointer to this to receive the result.
*
- * @param config Pointer to configuration structure.
- * @param dsr_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] dsr_ptr Pointer to a variable to store the result. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the DSR pin behaviour in a port configuration.
*
- * @param config Pointer to configuration structure.
- * @param dsr DSR pin mode, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] dsr DSR pin mode, or -1 to retain the current setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the XON/XOFF configuration for the specified serial port.
*
- * @param port Pointer to port structure.
- * @param xon_xoff XON/XOFF mode.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] xon_xoff XON/XOFF mode.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Get the XON/XOFF configuration from a port configuration.
*
- * The user should allocate a variable of type enum sp_xonxoff and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_xonxoff and
+ * pass a pointer to this to receive the result.
*
- * @param config Pointer to configuration structure.
- * @param xon_xoff_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] xon_xoff_ptr Pointer to a variable to store the result. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Set the XON/XOFF configuration in a port configuration.
*
- * @param config Pointer to configuration structure.
- * @param xon_xoff XON/XOFF mode, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] xon_xoff XON/XOFF mode, or -1 to retain the current setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
* type. For more fine-grained control of these settings, use their
* individual configuration functions.
*
- * @param config Pointer to configuration structure.
- * @param flowcontrol Flow control setting to use.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] flowcontrol Flow control setting to use.
*
* @return SP_OK upon success, a negative error code otherwise.
*
* type. For more fine-grained control of these settings, use their
* individual configuration functions.
*
- * @param port Pointer to port structure.
- * @param flowcontrol Flow control setting to use.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] flowcontrol Flow control setting to use.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* @}
- * @defgroup Data Reading, writing, and flushing data
+ *
+ * @defgroup Data Data handling
+ *
+ * Reading, writing, and flushing data.
+ *
* @{
-*/
+ */
/**
* Read bytes from the specified serial port, blocking until complete.
* sp_get_port_handle() and use this to call select() or pselect(),
* with appropriate arrangements to return if a signal is received.
*
- * @param port Pointer to port structure.
- * @param buf Buffer in which to store the bytes read.
- * @param count Requested number of bytes to read.
- * @param timeout Timeout in milliseconds, or zero to wait indefinitely.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
+ * @param[in] count Requested number of bytes to read.
+ * @param[in] timeout Timeout in milliseconds, or zero to wait indefinitely.
*
* @return The number of bytes read on success, or a negative error code. If
* the number of bytes returned is less than that requested, the
/**
* Read bytes from the specified serial port, without blocking.
*
- * @param port Pointer to port structure.
- * @param buf Buffer in which to store the bytes read.
- * @param count Maximum number of bytes to read.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
+ * @param[in] count Maximum number of bytes to read.
*
* @return The number of bytes read on success, or a negative error code. The
* number of bytes returned may be any number from zero to the maximum
* sp_get_port_handle() and use this to call select() or pselect(),
* with appropriate arrangements to return if a signal is received.
*
- * @param port Pointer to port structure.
- * @param buf Buffer containing the bytes to write.
- * @param count Requested number of bytes to write.
- * @param timeout Timeout in milliseconds, or zero to wait indefinitely.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] buf Buffer containing the bytes to write. Must not be NULL.
+ * @param[in] count Requested number of bytes to write.
+ * @param[in] timeout Timeout in milliseconds, or zero to wait indefinitely.
*
* @return The number of bytes written on success, or a negative error code.
* If the number of bytes returned is less than that requested, the
* written. If timeout is zero, the function will always return
* either the requested number of bytes or a negative error code. In
* the event of an error there is no way to determine how many bytes
- * were sent before the error occured.
+ * were sent before the error occurred.
*
* @since 0.1.0
*/
* been transmitted, use the sp_output_waiting() function. To wait until all
* written bytes have actually been transmitted, use the sp_drain() function.
*
- * @param port Pointer to port structure.
- * @param buf Buffer containing the bytes to write.
- * @param count Maximum number of bytes to write.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] buf Buffer containing the bytes to write. Must not be NULL.
+ * @param[in] count Maximum number of bytes to write.
*
* @return The number of bytes written on success, or a negative error code.
* The number of bytes returned may be any number from zero to the
/**
* Gets the number of bytes waiting in the input buffer.
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return Number of bytes waiting on success, a negative error code otherwise.
*
/**
* Gets the number of bytes waiting in the output buffer.
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return Number of bytes waiting on success, a negative error code otherwise.
*
/**
* Flush serial port buffers. Data in the selected buffer(s) is discarded.
*
- * @param port Pointer to port structure.
- * @param buffers Which buffer(s) to flush.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] buffers Which buffer(s) to flush.
*
* @return SP_OK upon success, a negative error code otherwise.
*
* signal handler, you would need to implement your own blocking
* drain by polling the result of sp_output_waiting().
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* @}
- * @defgroup Waiting Waiting for events
+ *
+ * @defgroup Waiting Waiting
+ *
+ * Waiting for events and timeout handling.
+ *
* @{
*/
*
* The result should be freed after use by calling sp_free_event_set().
*
+ * @param[out] result_ptr If any error is returned, the variable pointed to by
+ * result_ptr will be set to NULL. Otherwise, it will
+ * be set to point to the event set. Must not be NULL.
+ *
* @return SP_OK upon success, a negative error code otherwise.
*
* @since 0.1.0
* After the port is closed or the port structure freed, the results may
* no longer be valid.
*
- * @param event_set Event set to update.
- * @param port Pointer to port structure.
- * @param mask Bitmask of events to be waited for.
+ * @param[in,out] event_set Event set to update. Must not be NULL.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] mask Bitmask of events to be waited for.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Wait for any of a set of events to occur.
*
- * @param event_set Event set to wait on.
- * @param timeout Timeout in milliseconds, or zero to wait indefinitely.
+ * @param[in] event_set Event set to wait on. Must not be NULL.
+ * @param[in] timeout Timeout in milliseconds, or zero to wait indefinitely.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Free a structure allocated by sp_new_event_set().
*
+ * @param[in] event_set Event set to free. Must not be NULL.
+ *
* @since 0.1.0
*/
void sp_free_event_set(struct sp_event_set *event_set);
/**
* @}
- * @defgroup Signals Port signalling operations
+ *
+ * @defgroup Signals Signals
+ *
+ * Port signalling operations.
+ *
* @{
*/
* in which individual signals can be checked by bitwise OR with values of
* the sp_signal enum.
*
- * @param port Pointer to port structure.
- * @param signal_mask Pointer to variable to receive result.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] signal_mask Pointer to a variable to receive the result.
+ * Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Put the port transmit line into the break state.
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* Take the port transmit line out of the break state.
*
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
/**
* @}
- * @defgroup Errors Obtaining error information
+ *
+ * @defgroup Errors Errors
+ *
+ * Obtaining error information.
+ *
* @{
-*/
+ */
/**
* Get the error code for a failed operation.
/**
* Free an error message returned by sp_last_error_message().
*
+ * @param[in] message The error message string to free. Must not be NULL.
+ *
* @since 0.1.0
*/
void sp_free_error_message(char *message);
*
* The default handler is sp_default_debug_handler().
*
+ * @param[in] handler The handler function to use. Can be NULL (in that case
+ * all debug messages will be ignored).
+ *
* @since 0.1.0
*/
void sp_set_debug_handler(void (*handler)(const char *format, ...));
* environment variable LIBSERIALPORT_DEBUG is set. Otherwise, they are
* ignored.
*
+ * @param[in] format The format string to use. Must not be NULL.
+ * @param[in] ... The variable length argument list to use.
+ *
* @since 0.1.0
*/
void sp_default_debug_handler(const char *format, ...);
/** @} */
/**
- * @defgroup Versions Version number querying functions, definitions, and macros
+ * @defgroup Versions Versions
+ *
+ * Version number querying functions, definitions, and macros.
*
* This set of API calls returns two different version numbers related
* to libserialport. The "package version" is the release version number of the
projects / libserialport.git / blobdiff