X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=libserialport.h.in;h=51d9afe6c1449c5a57d69f33da1daffd329b7cd6;hb=0666ccc7ca446ce2960630e2707389852c812284;hp=a4f0b0ff76d1d8786c13e010b649c404abb75170;hpb=a93fb468885de8775f1d200625dac114d3050b1d;p=libserialport.git diff --git a/libserialport.h.in b/libserialport.h.in index a4f0b0f..51d9afe 100644 --- a/libserialport.h.in +++ b/libserialport.h.in @@ -100,7 +100,7 @@ enum sp_return { /** 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. */ @@ -108,7 +108,7 @@ enum sp_mode { /** Open port for read access. */ SP_MODE_READ = 1, /** Open port for write access. */ - SP_MODE_WRITE = 2, + SP_MODE_WRITE = 2 }; /** Port events. */ @@ -118,7 +118,7 @@ enum sp_event { /* Ready to transmit new data. */ SP_EVENT_TX_READY = 2, /* Error occured. */ - SP_EVENT_ERROR = 4, + SP_EVENT_ERROR = 4 }; /** Buffer selection. */ @@ -128,7 +128,7 @@ enum sp_buffer { /** Output buffer. */ SP_BUF_OUTPUT = 2, /** Both buffers. */ - SP_BUF_BOTH = 3, + SP_BUF_BOTH = 3 }; /** Parity settings. */ @@ -144,7 +144,7 @@ enum sp_parity { /** Mark parity. */ SP_PARITY_MARK = 3, /** Space parity. */ - SP_PARITY_SPACE = 4, + SP_PARITY_SPACE = 4 }; /** RTS pin behaviour. */ @@ -156,7 +156,7 @@ enum sp_rts { /** RTS on. */ SP_RTS_ON = 1, /** RTS used for flow control. */ - SP_RTS_FLOW_CONTROL = 2, + SP_RTS_FLOW_CONTROL = 2 }; /** CTS pin behaviour. */ @@ -166,7 +166,7 @@ enum sp_cts { /** CTS ignored. */ SP_CTS_IGNORE = 0, /** CTS used for flow control. */ - SP_CTS_FLOW_CONTROL = 1, + SP_CTS_FLOW_CONTROL = 1 }; /** DTR pin behaviour. */ @@ -178,7 +178,7 @@ enum sp_dtr { /** DTR on. */ SP_DTR_ON = 1, /** DTR used for flow control. */ - SP_DTR_FLOW_CONTROL = 2, + SP_DTR_FLOW_CONTROL = 2 }; /** DSR pin behaviour. */ @@ -188,7 +188,7 @@ enum sp_dsr { /** 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. */ @@ -202,7 +202,7 @@ enum sp_xonxoff { /** 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. */ @@ -214,7 +214,7 @@ enum sp_flowcontrol { /** 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. */ @@ -226,7 +226,7 @@ enum sp_signal { /** Data carrier detect. */ SP_SIG_DCD = 4, /** Ring indicator. */ - SP_SIG_RI = 8, + SP_SIG_RI = 8 }; /** Transport types. */ @@ -236,7 +236,7 @@ enum sp_transport { /** USB serial port adapter. */ SP_TRANSPORT_USB, /** Bluetooh serial port adapter. */ - SP_TRANSPORT_BLUETOOTH, + SP_TRANSPORT_BLUETOOTH }; /** @@ -475,12 +475,12 @@ char *sp_get_port_usb_product(const struct sp_port *port); char *sp_get_port_usb_serial(const struct sp_port *port); /** - * Get the bluetooth address of a bluetooth serial adapter port. + * Get the MAC address of a Bluetooth serial adapter port. * * @param port Pointer to port structure. * - * @return The port bluetooth address, or NULL if an invalid port is passed. - * The bluetooth address string is part of the port structure and may not be used + * @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. * * @since 0.2.0 @@ -1196,13 +1196,13 @@ void sp_free_event_set(struct sp_event_set *event_set); * the sp_signal enum. * * @param port Pointer to port structure. - * @param signals Pointer to variable to receive result. + * @param signal_mask Pointer to variable to receive result. * * @return SP_OK upon success, a negative error code otherwise. * * @since 0.1.0 */ -enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals); +enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signal_mask); /** * Put the port transmit line into the break state.