5cda838a93
Other minor changes to prepare for integration into cwIo. In cwMidi* replaced 'byte_t' with 'uint8_t'. In cwAudioDevice* removed redundant 'device' prefix from function names.
58 lines
2.3 KiB
C++
58 lines
2.3 KiB
C++
#ifndef cwSerialPort_H
|
|
#define cwSerialPort_H
|
|
|
|
#include "cwSerialPortDecls.h"
|
|
|
|
namespace cw
|
|
{
|
|
namespace serialPort
|
|
{
|
|
|
|
typedef handle<struct device_str> handle_t;
|
|
typedef void (*callbackFunc_t)( void* cbArg, unsigned userId, const void* byteA, unsigned byteN );
|
|
|
|
rc_t create( handle_t& h, unsigned recvBufByteN=512 );
|
|
rc_t destroy( handle_t& h );
|
|
|
|
rc_t createPort( handle_t h, unsigned userId, const char* device, unsigned baudRate, unsigned cfgFlags, callbackFunc_t cbFunc, void* cbArg );
|
|
rc_t destroyPort( handle_t h, unsigned userId );
|
|
|
|
unsigned portCount( handle_t h );
|
|
unsigned portIndexToId( handle_t h, unsigned index );
|
|
|
|
bool isopen( handle_t h, unsigned userId );
|
|
|
|
rc_t send( handle_t h, unsigned userId, const void* byteA, unsigned byteN );
|
|
|
|
|
|
// Non-blocking - Receive data from a specific port if data is available.
|
|
// If buf==nullptr then use the ports callback function to deliver the received data,
|
|
// otherwise return the data in buf[bufByteN].
|
|
rc_t receive_nb( handle_t h, unsigned userId, unsigned& readN_Ref, void* buf=nullptr, unsigned bufByteN=0);
|
|
|
|
|
|
// Blocking - Wait up to timeOutMs milliseconds for data to be available on any of the ports.
|
|
// Deliver received data via the port callback function.
|
|
// readN_Ref returns the total count of bytes read across all ports.
|
|
rc_t receive( handle_t h, unsigned timeOutMs, unsigned& readN_Ref);
|
|
|
|
// Blocking - Wait up to timeOutMs milliseconds for data to be available on a specific port. Return the received data in buf[bufByteN].
|
|
rc_t receive( handle_t h, unsigned timeOutMs, unsigned& readN_Ref, unsigned userId, void* buf, unsigned bufByteN );
|
|
|
|
const char* device( handle_t h, unsigned userId );
|
|
|
|
// Get the baud rate and cfgFlags used to initialize the port
|
|
unsigned baudRate( handle_t h, unsigned userId );
|
|
unsigned cfgFlags( handle_t h, unsigned userId );
|
|
|
|
// Get the baud rate and cfg flags by reading the device.
|
|
// Note the the returned buad rate is a system id rather than the actual baud rate,
|
|
// however the cfgFlags are converted to the same kXXXFl defined in this class.
|
|
unsigned readInBaudRate( handle_t h, unsigned userId );
|
|
unsigned readOutBaudRate( handle_t h, unsigned userId );
|
|
unsigned readCfgFlags( handle_t h, unsigned userId );
|
|
}
|
|
}
|
|
|
|
#endif
|