sio.h

来自「在luminary平台下移植lwip到freertos,集成开发环境KEIL」· C头文件 代码 · 共 90 行

#ifndef SIO_H
#define SIO_H

#include "lwip/sys.h"
#include "lwip/netif.h"
#include "netif/fifo.h"
/*#include "netif/pppif.h"*/
/* BAUDRATE is defined in sio.c as it is implementation specific */

#define B9600	9600
#define B19200	19200
#define B38400	38400
#define B57600	57600
#define B115200 115200


typedef struct sio_status_t {
	int fd;
	fifo_t myfifo;
} sio_status_t;


/** Baudrates */
typedef enum sioBaudrates {
	SIO_BAUD_9600,
	SIO_BAUD_19200,
	SIO_BAUD_38400,
	SIO_BAUD_57600,	
	SIO_BAUD_115200	
} sioBaudrates;

/**
* Read a char from incoming data stream, this call blocks until data has arrived
* @param 	siostat siostatus struct, contains sio instance data, given by sio_open
* @return 	char read from input stream
*/
u8_t sio_recv( sio_status_t * siostat );

/**
* Poll for a new character from incoming data stream
* @param 	siostat siostatus struct, contains sio instance data, given by sio_open
* @return 	char read from input stream, or < 0 if no char was available
*/
s16_t sio_poll(sio_status_t * siostat);

/**
*	Parse incoming characters until a string str is recieved, blocking call
* @param	str		zero terminated string to expect
* @param 	siostat siostatus struct, contains sio instance data, given by sio_open
*/
void sio_expect_string(u8_t *str, sio_status_t * siostat);

/**
* Write a char to output data stream
* @param 	c		char to write to output stream
* @param 	siostat siostatus struct, contains sio instance data, given by sio_open
*/
void sio_send( u8_t c, sio_status_t * siostat );

/**
* Write a char to output data stream
* @param 	str		pointer to a zero terminated string
* @param	siostat siostatus struct, contains sio instance data, given by sio_open
*/
void sio_send_string(u8_t *str, sio_status_t * siostat);

/**
*	Flush outbuffer (send everything in buffer now), useful if some layer below is 
*	holding on to data, waitng to fill a buffer
* @param 	siostat siostatus struct, contains sio instance data, given by sio_open
*/
void sio_flush( sio_status_t * siostat );

/**
* Open serial port entry point from serial protocol (slipif, pppif)
* @param	devnum	the device number to use, i.e. ttySx, comx:, etc. there x = devnum
* @return 	siostatus struct, contains sio instance data, use when calling sio functions
*/
sio_status_t * sio_open( int devnum );

/**
*	Change baudrate of port, may close and reopen port
* @param 	baud	new baudrate
* @param 	siostat siostatus struct, contains sio instance data, given by sio_open
*/
void sio_change_baud( sioBaudrates baud, sio_status_t * siostat );

#endif