Added notes, removed unused types.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12303 110e8d01-0319-4d1e-a829-52ad28d1bb01
This commit is contained in:
Giovanni Di Sirio 2018-09-28 09:30:06 +00:00
parent 3f4d993626
commit e442d39b3e
2 changed files with 13 additions and 14 deletions

View File

@ -81,22 +81,17 @@ typedef enum {
SIO_READY = 2 /**< Ready. */
} siostate_t;
/**
* @brief Type of a function writing a frame received by SIO.
*/
typedef msg_t (*sioput_t)(void *p, uint8_t b);
/**
* @brief Type of a function reading a frame to be transmitted by SIO.
*/
typedef msg_t (*sioget_t)(void *p);
#include "hal_sio_lld.h"
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @brief Returns the current set of flags and clears it.
*/
#define sioGetFlagsX(siop) sio_lld_get_flags(siop)
/**
* @brief Determines the state of the RX FIFO.
*

View File

@ -86,20 +86,24 @@ typedef void (*sioecb_t)(SIODriver *siop, sioflags_t e);
struct hal_sio_config {
/**
* @brief Receive buffer filled callback.
* @note Can be @p NULL.
*/
siocb_t rxne_cb;
/**
* @brief End of transmission buffer callback.
* @note Can be @p NULL.
*/
siocb_t txnf_cb;
/**
* @brief Physical end of transmission callback.
* @note Can be @p NULL.
*/
siocb_t txend_cb;
/**
* @brief Receive event callback.
* @note Can be @p NULL.
*/
sioecb_t rxevt_cb;
siocb_t rxevt_cb;
/* End of the mandatory fields.*/
};