aboutsummaryrefslogtreecommitdiffstats
path: root/src/chserial.c
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-01-11 11:28:32 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-01-11 11:28:32 +0000
commit382151cf63ff5ef3144fc38bb87490d33da7b2d3 (patch)
treea1ebbe48fe92cc5fa9f6a0493812269820747b9d /src/chserial.c
parent36c9110259212470667c7cc95bb99ca577945d87 (diff)
downloadChibiOS-382151cf63ff5ef3144fc38bb87490d33da7b2d3.tar.gz
ChibiOS-382151cf63ff5ef3144fc38bb87490d33da7b2d3.tar.bz2
ChibiOS-382151cf63ff5ef3144fc38bb87490d33da7b2d3.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@619 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'src/chserial.c')
-rw-r--r--src/chserial.c28
1 files changed, 14 insertions, 14 deletions
diff --git a/src/chserial.c b/src/chserial.c
index 4ab65e140..c41bc2c4a 100644
--- a/src/chserial.c
+++ b/src/chserial.c
@@ -29,15 +29,15 @@
* Initializes a generic full duplex driver. The HW dependent part of the
* initialization has to be performed outside, usually in the hardware
* initialization code.
- * @param sd pointer to a \p FullDuplexDriver structure
+ * @param sd pointer to a @p FullDuplexDriver structure
* @param ib pointer to a memory area allocated for the Input Queue buffer
* @param isize size of the Input Queue buffer
* @param inotify pointer to a callback function that is invoked when
- * some data is read from the Queue. The value can be \p NULL.
+ * some data is read from the Queue. The value can be @p NULL.
* @param ob pointer to a memory area allocated for the Output Queue buffer
* @param osize size of the Output Queue buffer
* @param onotify pointer to a callback function that is invoked when
- * some data is written in the Queue. The value can be \p NULL.
+ * some data is written in the Queue. The value can be @p NULL.
*/
void chFDDInit(FullDuplexDriver *sd,
uint8_t *ib, size_t isize, qnotify_t inotify,
@@ -54,7 +54,7 @@ void chFDDInit(FullDuplexDriver *sd,
/**
* This function must be called from the input interrupt service routine in
* order to enqueue incoming data and generate the related events.
- * @param sd pointer to a \p FullDuplexDriver structure
+ * @param sd pointer to a @p FullDuplexDriver structure
* @param b the byte to be written in the driver's Input Queue
*/
void chFDDIncomingDataI(FullDuplexDriver *sd, uint8_t b) {
@@ -69,7 +69,7 @@ void chFDDIncomingDataI(FullDuplexDriver *sd, uint8_t b) {
* Must be called from the output interrupt service routine in order to get
* the next byte to be transmitted.
*
- * @param sd pointer to a \p FullDuplexDriver structure
+ * @param sd pointer to a @p FullDuplexDriver structure
* @return The byte value read from the driver's output queue.
* @retval Q_EMPTY if the queue is empty (the lower driver usually disables
* the interrupt source when this happens).
@@ -85,7 +85,7 @@ msg_t chFDDRequestDataI(FullDuplexDriver *sd) {
/**
* Must be called from the I/O interrupt service routine in order to
* notify I/O conditions as errors, signals change etc.
- * @param sd pointer to a \p FullDuplexDriver structure
+ * @param sd pointer to a @p FullDuplexDriver structure
* @param mask condition flags to be added to the mask
*/
void chFDDAddFlagsI(FullDuplexDriver *sd, dflags_t mask) {
@@ -96,7 +96,7 @@ void chFDDAddFlagsI(FullDuplexDriver *sd, dflags_t mask) {
/**
* This function returns and clears the errors mask associated to the driver.
- * @param sd pointer to a \p FullDuplexDriver structure
+ * @param sd pointer to a @p FullDuplexDriver structure
* @return The condition flags modified since last time this function was
* invoked.
*/
@@ -114,13 +114,13 @@ dflags_t chFDDGetAndClearFlags(FullDuplexDriver *sd) {
* Initializes a generic half duplex driver. The HW dependent part of the
* initialization has to be performed outside, usually in the hardware
* initialization code.
- * @param sd pointer to a \p HalfDuplexDriver structure
+ * @param sd pointer to a @p HalfDuplexDriver structure
* @param b pointer to a memory area allocated for the queue buffer
* @param size the buffer size
* @param inotify pointer to a callback function that is invoked when
- * some data is read from the queue. The value can be \p NULL.
+ * some data is read from the queue. The value can be @p NULL.
* @param onotify pointer to a callback function that is invoked when
- * some data is written in the queue. The value can be \p NULL.
+ * some data is written in the queue. The value can be @p NULL.
*/
void chHDDInit(HalfDuplexDriver *sd, uint8_t *b, size_t size,
qnotify_t inotify, qnotify_t onotify) {
@@ -135,7 +135,7 @@ void chHDDInit(HalfDuplexDriver *sd, uint8_t *b, size_t size,
/**
* This function must be called from the input interrupt service routine in
* order to enqueue incoming data and generate the related events.
- * @param sd pointer to a \p FullDuplexDriver structure
+ * @param sd pointer to a @p FullDuplexDriver structure
* @param b the byte to be written in the driver's input queue
*/
void chHDDIncomingDataI(HalfDuplexDriver *sd, uint8_t b) {
@@ -150,7 +150,7 @@ void chHDDIncomingDataI(HalfDuplexDriver *sd, uint8_t b) {
* Must be called from the output interrupt service routine in order to get
* the next byte to be transmitted.
*
- * @param sd pointer to a \p HalfDuplexDriver structure
+ * @param sd pointer to a @p HalfDuplexDriver structure
* @return The byte value read from the driver's output queue.
* @retval Q_EMPTY if the queue is empty (the lower driver usually disables
* the interrupt source when this happens).
@@ -166,7 +166,7 @@ msg_t chHDDRequestDataI(HalfDuplexDriver *sd) {
/**
* Must be called from the I/O interrupt service routine in order to
* notify I/O conditions as errors, signals change etc.
- * @param sd pointer to a \p HalfDuplexDriver structure
+ * @param sd pointer to a @p HalfDuplexDriver structure
* @param mask condition flags to be added to the mask
*/
void chHDDAddFlagsI(HalfDuplexDriver *sd, dflags_t mask) {
@@ -177,7 +177,7 @@ void chHDDAddFlagsI(HalfDuplexDriver *sd, dflags_t mask) {
/**
* This function returns and clears the errors mask associated to the driver.
- * @param sd pointer to a \p HalfDuplexDriver structure
+ * @param sd pointer to a @p HalfDuplexDriver structure
* @return The condition flags modified since last time this function was
* invoked.
*/