xbee_serial_rabbit.c File Reference

Serial Interface for XBee Module (Rabbit Platform) More...

#include <limits.h>
#include <errno.h>
#include <stdio.h>
#include "xbee/platform.h"
#include "xbee/serial.h"

Macros
#define	_xbee_serial_debug   __nodebug
#define	XBEE_SER_CHECK(ptr)   do { if (xbee_ser_invalid(ptr)) return -EINVAL; } while (0)

Functions
int	xbee_ser_invalid (xbee_serial_t *serial)
	Helper function used by other xbee_serial functions to validate the serial parameter. More...
const char *	xbee_ser_portname (xbee_serial_t *serial)
	Returns a human-readable string describing the serial port. More...
int	xbee_ser_write (xbee_serial_t *serial, const void FAR *buffer, int length)
	Transmits length bytes from buffer to the XBee serial port serial. More...
int	xbee_ser_read (xbee_serial_t *serial, void FAR *buffer, int bufsize)
	Reads up to bufsize bytes from XBee serial port serial and into buffer. More...
int	xbee_ser_putchar (xbee_serial_t *serial, uint8_t ch)
	Transmits a single character, ch, to the XBee serial port serial. More...
int	xbee_ser_getchar (xbee_serial_t *serial)
	Reads a single character from the XBee serial port serial. More...
int	xbee_ser_tx_free (xbee_serial_t *serial)
	Returns the number of bytes of unused space in the serial transmit buffer for XBee serial port serial. More...
int	xbee_ser_tx_used (xbee_serial_t *serial)
	Returns the number of queued bytes in the serial transmit buffer for XBee serial port serial. More...
int	xbee_ser_tx_flush (xbee_serial_t *serial)
	Flushes (i.e., deletes and does not transmit) characters in the serial transmit buffer for XBee serial port serial. More...
int	xbee_ser_rx_free (xbee_serial_t *serial)
	Returns the number of bytes of unused space in the serial receive buffer for XBee serial port serial. More...
int	xbee_ser_rx_used (xbee_serial_t *serial)
	Returns the number of queued bytes in the serial receive buffer for XBee serial port serial. More...
int	xbee_ser_rx_flush (xbee_serial_t *serial)
	Deletes all characters in the serial receive buffer for XBee serial port serial. More...
int	xbee_ser_open (xbee_serial_t *serial, uint32_t baudrate)
	Opens the serial port connected to XBee serial port serial at baudrate bits/second. More...
int	xbee_ser_close (xbee_serial_t *serial)
	Close the serial port attached to XBee serial port serial. More...
int	xbee_ser_break (xbee_serial_t *serial, int enabled)
	Disable the serial transmit pin and pull it low to send a break to the XBee serial port. More...
int	xbee_ser_flowcontrol (xbee_serial_t *serial, int enabled)
	Enable or disable hardware flow control (CTS/RTS) on the serial port for XBee serial port serial. More...
int	xbee_ser_set_rts (xbee_serial_t *serial, int asserted)
	Disable hardware flow control and manually set the RTS (ready to send) pin on the XBee device's serial port. More...
int	xbee_ser_get_cts (xbee_serial_t *serial)
	Read the status of the /CTS (clear to send) pin on the serial port connected to XBee serial port serial. More...

Detailed Description

Serial Interface for XBee Module (Rabbit Platform)

Define XBEE_ON_SERX for every serial port that will/may have an XBee, so we can compile in serXopen/serXclose functions for those ports.

Todo:

Need code to make sure IN and OUT buffers are large enough for XBee. Does the out buffer need to be large enough to hold an entire frame?