zcy
/
tinySA
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation-related fixes. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@8672 35acf78f-673a-0410-8e92-d51de3d6d3f4
master
Giovanni Di Sirio 2016-01-03 10:53:23 +00:00
parent 4c12fb1364
commit 1a7524add7
9 changed files with 74 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
os/hal/dox/hal_buffers.dox Normal file
View File

@ -0,0 +1,20 @@
/*
ChibiOS - Copyright (C) 2006..2015 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_BUFFERS I/O Buffers Queues
* @ingroup HAL_INNER_CODE
*/

2
os/hal/dox/hal_queues.dox
View File

@ -15,6 +15,6 @@
*/
/**
* @defgroup HAL_QUEUES I/O Queues
* @defgroup HAL_QUEUES I/O Bytes Queues
* @ingroup HAL_INNER_CODE
*/

26
os/hal/dox/wdg.dox Normal file
View File

@ -0,0 +1,26 @@
/*
ChibiOS - Copyright (C) 2006..2015 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup WDG WDG Driver
* @brief Watchdog Timer Abstraction Layer
* @details This module defines an abstract interface for a watchdog
* timer.
* @pre In order to use the WDG driver the @p HAL_USE_WDG option
* must be enabled in @p halconf.h.
*
* @ingroup HAL_NORMAL_DRIVERS
*/

4
os/hal/include/hal_buffers.h
View File

@ -205,8 +205,8 @@ typedef io_buffers_queue_t output_buffers_queue_t;
*
* @iclass
*/
#define obqIsEmptyI(oqp) ((bool)(((obqp)->bwrptr == (obqp)->brdptr) && \
((obqp)->bcounter != 0U)))
#define obqIsEmptyI(obqp) ((bool)(((obqp)->bwrptr == (obqp)->brdptr) && \
((obqp)->bcounter != 0U)))
/**
* @brief Evaluates to @p true if the specified output buffers queue is full.

1
os/hal/include/uart.h
View File

@ -268,6 +268,7 @@ typedef enum {
* implementation only.
*
* @param[in] uartp pointer to the @p UARTDriver object
* @param[in] errors mask of errors to be reported
*
* @notapi
*/

2
os/hal/ports/STM32/LLD/xWDGv1/wdg_lld.c
View File

@ -126,7 +126,7 @@ void wdg_lld_stop(WDGDriver *wdgp) {
/**
* @brief Reloads WDG's counter.
*
* @param[in] idwgp pointer to the @p WDGDriver object
* @param[in] wdgp pointer to the @p WDGDriver object
*
* @notapi
*/

23
os/hal/src/hal_buffers.c
View File

@ -19,6 +19,20 @@
* @brief I/O Buffers code.
*
* @addtogroup HAL_BUFFERS
* @details Buffers Queues are used when there is the need to exchange
* fixed-length data buffers between ISRs and threads.
* On the ISR side data can be exchanged only using buffers,
* on the thread side data can be exchanged both using buffers and/or
* using an emulation of regular byte queues.
* There are several kind of buffers queues:<br>
* - <b>Input queue</b>, unidirectional queue where the writer is the
* ISR side and the reader is the thread side.
* - <b>Output queue</b>, unidirectional queue where the writer is the
* ISR side and the reader is the thread side.
* - <b>Full duplex queue</b>, bidirectional queue. Full duplex queues
* are implemented by pairing an input queue and an output queue
* together.
* .
* @{
*/
@ -155,7 +169,7 @@ void ibqPostFullBufferI(input_buffers_queue_t *ibqp, size_t size) {
* @brief Gets the next filled buffer from the queue.
* @note The function always acquires the same buffer if called repeatedly.
* @post After calling the function the fields @p ptr and @p top are set
* at beginning and end of the buffer data or @NULL if the queue
* at beginning and end of the buffer data or @p NULL if the queue
* is empty.
*
* @param[in] ibqp pointer to the @p input_buffers_queue_t object
@ -186,7 +200,7 @@ msg_t ibqGetFullBufferTimeout(input_buffers_queue_t *ibqp,
* @brief Gets the next filled buffer from the queue.
* @note The function always acquires the same buffer if called repeatedly.
* @post After calling the function the fields @p ptr and @p top are set
* at beginning and end of the buffer data or @NULL if the queue
* at beginning and end of the buffer data or @p NULL if the queue
* is empty.
*
* @param[in] ibqp pointer to the @p input_buffers_queue_t object
@ -525,7 +539,7 @@ void obqReleaseEmptyBufferI(output_buffers_queue_t *obqp) {
* @brief Gets the next empty buffer from the queue.
* @note The function always acquires the same buffer if called repeatedly.
* @post After calling the function the fields @p ptr and @p top are set
* at beginning and end of the buffer data or @NULL if the queue
* at beginning and end of the buffer data or @p NULL if the queue
* is empty.
*
* @param[in] obqp pointer to the @p output_buffers_queue_t object
@ -556,7 +570,7 @@ msg_t obqGetEmptyBufferTimeout(output_buffers_queue_t *obqp,
* @brief Gets the next empty buffer from the queue.
* @note The function always acquires the same buffer if called repeatedly.
* @post After calling the function the fields @p ptr and @p top are set
* at beginning and end of the buffer data or @NULL if the queue
* at beginning and end of the buffer data or @p NULL if the queue
* is empty.
*
* @param[in] obqp pointer to the @p output_buffers_queue_t object
@ -650,6 +664,7 @@ void obqPostFullBufferS(output_buffers_queue_t *obqp, size_t size) {
* new buffer is freed in the queue or a timeout occurs.
*
* @param[in] obqp pointer to the @p output_buffers_queue_t object
* @param[in] b byte value to be transferred
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.

4
os/hal/src/uart.c
View File

@ -320,7 +320,7 @@ size_t uartStopReceive(UARTDriver *uartp) {
* @note Stopping a receive operation also suppresses the receive callbacks.
* @note This function has to be invoked from a lock zone.
*
* @param[in] uartp pointer to the @p UARTDriver object
* @param[in] uartp pointer to the @p UARTDriver object
*
* @return The number of data frames not received by the
* stopped receive operation.
@ -354,6 +354,7 @@ size_t uartStopReceiveI(UARTDriver *uartp) {
* @param[in,out] np number of data frames to transmit, on exit the number
* of frames actually transmitted
* @param[in] txbuf the pointer to the transmit buffer
* @param[in] time operation timeout
* @return The operation status.
* @retval MSG_OK if the operation completed successfully.
* @retval MSG_TIMEOUT if the operation timed out.
@ -396,6 +397,7 @@ msg_t uartSendTimeout(UARTDriver *uartp, size_t *np,
* @param[in,out] np number of data frames to transmit, on exit the number
* of frames actually transmitted
* @param[in] txbuf the pointer to the transmit buffer
* @param[in] time operation timeout
* @return The operation status.
* @retval MSG_OK if the operation completed successfully.
* @retval MSG_TIMEOUT if the operation timed out.

2
os/hal/templates/wdg_lld.c
View File

@ -88,7 +88,7 @@ void wdg_lld_stop(WDGDriver *wdgp) {
/**
* @brief Reloads WDG's counter.
*
* @param[in] idwgp pointer to the @p WDGDriver object
* @param[in] wdgp pointer to the @p WDGDriver object
*
* @notapi
*/