README

   1 ----------------------------------------------------------------
   2 libserialport: cross-platform library for accessing serial ports
   3 ----------------------------------------------------------------
   4
   5 libserialport is a minimal library written in C that is intended to take care
   6 of the OS-specific details when writing software that uses serial ports.
   7
   8 By writing your serial code to use libserialport, you enable it to work
   9 transparently on any platform supported by the library.
  10
  11 The operations that are supported are:
  12
  13 - Port enumeration (obtaining a list of serial ports on the system).
  14 - Opening and closing ports.
  15 - Setting port parameters (baud rate, parity, etc).
  16 - Reading, writing and flushing data.
  17 - Obtaining error information.
  18
  19 libserialport is an open source project released under the LGPL3+ license.
  20
  21 Status
  22 ======
  23
  24 The library should build and work on any Windows or Unix-based system. If it
  25 does not, please submit a bug.
  26
  27 Enumeration is currently only implemented on Windows, Mac OS X and Linux. On
  28 other systems enumeration will return no results, but ports can still be opened
  29 by name and then used.
  30
  31 If you know how to enumerate available ports on another OS, please submit a bug
  32 with this information, or better still a patch implementing it.
  33
  34 Future
  35 ======
  36
  37 Future versions will add additional API calls for obtaining metadata about a
  38 port, e.g. for USB devices the USB VID and PID of the underlying device.
  39
  40 Dependencies
  41 ============
  42
  43 On Linux, libudev is required. On other systems no other libraries are required.
  44
  45 The libudev dependency could be eliminated in favour of direct sysfs queries at
  46 the cost of some brevity. This is not currently a priority but if you feel like
  47 doing this feel free to submit a patch.
  48
  49 Building
  50 ========
  51
  52 The package uses a GNU style build system and requires a Unix style shell.
  53 On Windows it can be built with the MinGW toolchain and MSYS environment.
  54
  55 Run "./autogen.sh" to generate the build system, "./configure" to setup, then
  56 "make" to build the library and "make install" to install it.
  57
  58 API
  59 ===
  60
  61 The API is simple, and designed to be a minimal wrapper around the serial port
  62 support in each OS.
  63
  64 Most functions take a pointer to a struct sp_port, which represents a serial
  65 port. These structures are always allocated and freed by the library, using the
  66 functions in the 'Enumeration' section below.
  67
  68 All functions can return only three possible error values. SP_ERR_ARG indicates
  69 the function was called with invalid arguments. SP_ERR_FAIL indicates that the
  70 OS reported a failure. SP_ERR_MEM indicates that a memory allocation failed.
  71 All of these error values are negative.
  72
  73 When SP_ERR_FAIL is returned, an error code or string description of the error
  74 can be obtained by calling sp_last_error_code() or sp_last_error_message(). The
  75 error code or message is that provided by the OS; libserialport does not define
  76 any error codes or messages of its own.
  77
  78 Functions calls that succeed return SP_OK, which is equal to zero, or where
  79 otherwise documented a positive value.
  80
  81 The available functions are as follows:
  82
  83 Enumeration
  84 -----------
  85
  86 int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
  87
  88  Obtains a pointer to a new sp_port structure representing the named port. The
  89  user should allocate a variable of type "struct sp_port *" and pass a pointer
  90  to this to receive the result.
  91
  92  The result should be freed after use by calling sp_free_port().
  93
  94  Returns: SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
  95           failure, or SP_ERR_ARG if an invalid pointer is passed. If any error
  96           is returned, the variable pointed to by port_ptr will be set to NULL.
  97           Otherwise, it will be set to point to the newly allocated port.
  98
  99 void sp_free_port(struct sp_port *port);
 100
 101  Frees a port structure obtained from sp_get_port_by_name().
 102
 103 int sp_list_ports(struct sp_port ***list_ptr);
 104
 105  Lists the serial ports available on the system. The result obtained is an
 106  array of pointers to sp_port structures, terminated by a NULL. The user should
 107  allocate a variable of type "struct sp_port **" and pass a pointer to this to
 108  receive the result.
 109
 110  The result should be freed after use by calling sp_free_port_list(). If a port
 111  from the list is to be used after freeing the list, it must be copied first
 112  using sp_copy_port().
 113
 114  Returns: SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
 115           failure, or SP_ERR_ARG if an invalid pointer is passed. If any error
 116           is returned, the variable pointed to by list_ptr will be set to NULL.
 117           Otherwise, it will be set to point to the newly allocated array.
 118
 119 int sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr);
 120
 121  Makes a new copy of a sp_port structure. The user should allocate a variable
 122  of type "struct sp_port *" and pass a pointer to this to receive the result.
 123
 124  The copy should be freed after use by calling sp_free_port().
 125
 126  Returns: SP_OK on success, SP_ERR_MEM on allocation failure, or SP_ERR_ARG
 127           if an invalid port or pointer is passed. If any error is returned,
 128           the variable pointed to by copy_ptr will be set to NULL. Otherwise,
 129           it will be set to point to the newly allocated copy.
 130
 131 void sp_free_port_list(struct sp_port **list);
 132
 133  Frees a port list obtained from sp_list_ports(). This will also free all
 134  the sp_port structures referred to from the list; any that are to be retained
 135  must be copied first using sp_copy_port().
 136
 137 Opening and closing ports
 138 -------------------------
 139
 140 int sp_open(struct sp_port *port, int flags);
 141
 142  Opens the specified serial port.
 143
 144  Parameters:
 145
 146   port:      Pointer to port structure.
 147   flags:     Flags to use when opening the serial port. Possible
 148              flags are: SP_MODE_RDWR, SP_MODE_RDONLY, and SP_MODE_NONBLOCK.
 149
 150  Returns: SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
 151           failure, or SP_ERR_ARG if an invalid port is passed.
 152
 153 int sp_close(struct sp_port *port);
 154
 155  Closes the specified serial port.
 156
 157  Returns: SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
 158           if an invalid port is passed.
 159
 160 Setting port parameters
 161 -----------------------
 162
 163 int sp_set_params(struct sp_port *port, int baudrate,
 164                               int bits, int parity, int stopbits,
 165                               int flowcontrol, int rts, int dtr);
 166
 167  Sets serial parameters for the specified serial port.
 168
 169  Parameters:
 170
 171   port:        Pointer to port structure.
 172   baudrate:    Baud rate to set.
 173   bits:        Number of data bits to use.
 174   parity:      Parity setting to use
 175                (SP_PARITY_NONE, SP_PARITY_EVEN or SP_PARITY_ODD)
 176   stopbits:    Number of stop bits to use (1 or 2).
 177   flowcontrol: Flow control setting to use
 178                (SP_FLOW_NONE, SP_FLOW_HARDWARE or SP_FLOW_SOFTWARE)
 179
 180  Returns: SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
 181           for invalid arguments.
 182
 183 Reading, writing and flushing data
 184 ----------------------------------
 185
 186 int sp_read(struct sp_port *port, const void *buf, size_t count)
 187
 188  Reads bytes from the specified serial port. Note that this function may
 189  return after reading less than the specified number of bytes; it is the
 190  user's responsibility to iterate as necessary in this case.
 191
 192  Parameters:
 193
 194   port:  Pointer to port structure.
 195   buf:   Buffer in which to store the bytes read.
 196   count: Maximum number of bytes to read.
 197
 198  Returns: The number of bytes read, SP_ERR_FAIL on failure,
 199           or SP_ERR_ARG for invalid arguments.
 200
 201 int sp_write(struct sp_port *port, const void *buf, size_t count)
 202
 203  Write bytes to the specified serial port. Note that this function may
 204  return after writing less than the specified number of bytes; it is the
 205  user's responsibility to iterate as necessary in this case.
 206
 207  Parameters:
 208
 209   port:  Pointer to port structure.
 210   buf:   Buffer containing the bytes to write.
 211   count: Maximum number of bytes to write.
 212
 213  Returns: The number of bytes written, SP_ERR_FAIL on failure,
 214           or SP_ERR_ARG for invalid arguments.
 215
 216 int sp_flush(struct sp_port *port);
 217
 218  Flushes serial port buffers.
 219
 220  Returns: SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
 221           if an invalid port is passed.
 222
 223 Error handling
 224 --------------
 225
 226 int sp_last_error_code();
 227
 228  Gets the error code for a failed operation.
 229
 230  In order to obtain the correct result, this function should be called
 231  straight after the failure, before executing any other system operations.
 232
 233  Returns: The system's numeric code for the error that caused the last
 234           operation to fail.
 235
 236 char *sp_last_error_message();
 237
 238  Gets the error message for failed operation.
 239
 240  In order to obtain the correct result, this function should be called
 241  straight after the failure, before executing other system operations.
 242
 243  Returns: The system's message for the error that caused the last
 244           operation to fail. This string may be allocated by the function,
 245           and should be freed after use by calling sp_free_error_message.
 246
 247 void sp_free_error_message(char *message);
 248
 249  Frees the error message returned by sp_last_error_message().