Documentation, comments: Minor improvements and typos fixed

This commit is contained in:
Nathan Hartman 2021-05-05 22:18:49 -04:00 committed by Xiang Xiao
parent 56d0fbf68e
commit 8af9d39667
40 changed files with 118 additions and 123 deletions

View file

@ -19,11 +19,10 @@ handlers may send messages via named message queues.
.. c:function:: mqd_t mq_open(const char *mqName, int oflags, ...)
Establishes a connection between a named
message queue and the calling task. After a successful call of
mq_open(), the task can reference the message queue using the address
returned by the call. The message queue remains usable until it is
closed by a successful call to mq_close().
Establishes a connection between a named message queue and the calling
task. After a successful call of mq_open(), the task can reference the
message queue using the address returned by the call. The message queue
remains usable until it is closed by a successful call to mq_close().
:param mqName: Name of the queue to open
:param oflags: Open flags. These may be any combination of:
@ -65,10 +64,10 @@ handlers may send messages via named message queues.
.. c:function:: int mq_close(mqd_t mqdes)
Used to indicate that the calling task
is finished with the specified message queued mqdes. The mq_close()
deallocates any system resources allocated by the system for use by this
task for its message queue.
Used to indicate that the calling task is finished with the specified
message queued ``mqdes``. The ``mq_close()`` deallocates any system
resources allocated by the system for use by this task for its message
queue.
If the calling task has attached a notification request to the message
queue via this ``mqdes`` (see ``mq_notify()``), this attachment will be
@ -104,10 +103,10 @@ handlers may send messages via named message queues.
.. c:function:: int mq_send(mqd_t mqdes, const void *msg, size_t msglen, int prio)
Adds the specified message, ``msg``, to
the message queue, ``mqdes``. The ``msglen`` parameter specifies the
length of the message in bytes pointed to by ``msg``. This length must
not exceed the maximum message length from the ``mq_getattr()``.
Adds the specified message, ``msg``, to the message queue, ``mqdes``.
The ``msglen`` parameter specifies the length of the message in bytes
pointed to by ``msg``. This length must not exceed the maximum message
length from the ``mq_getattr()``.
If the message queue is not full, ``mq_send()`` will place the ``msg``
in the message queue at the position indicated by the ``prio`` argument.
@ -125,14 +124,14 @@ handlers may send messages via named message queues.
However, it behaves differently when called from the interrupt level:
- It does not check the size of the queue. It will always post the
message, even if there is already too many messages in queue. This is
message, even if there are already too many messages in queue. This is
because the interrupt handler does not have the option of waiting for
the message queue to become non-full.
- It doesn't allocate new memory (because you cannot allocate memory
from an interrupt handler). Instead, there are are pool of
pre-allocated message structures that may be used just for sending
messages from interrupt handlers. The number of such pre-allocated
messages is a configuration parameter.
from an interrupt handler). Instead, there is a pool of pre-allocated
message structures that may be used just for sending messages from
interrupt handlers. The number of such pre-allocated messages is set
by the ``PREALLOC_MQ_IRQ_MSGS`` configuration parameter.
:param mqdes: Message queue descriptor.
:param msg: Message to send.
@ -157,10 +156,10 @@ handlers may send messages via named message queues.
.. c:function:: int mq_timedsend(mqd_t mqdes, const char *msg, size_t msglen, int prio, \
const struct timespec *abstime);
Adds the specified message, ``msg``, to
the message queue, ``mqdes``. The ``msglen`` parameter specifies the
length of the message in bytes pointed to by ``msg``. This length must
not exceed the maximum message length from the ``mq_getattr()``.
Adds the specified message, ``msg``, to the message queue, ``mqdes``.
The ``msglen`` parameter specifies the length of the message in bytes
pointed to by ``msg``. This length must not exceed the maximum message
length from the ``mq_getattr()``.
If the message queue is not full, ``mq_timedsend()`` will place the
``msg`` in the message queue at the position indicated by the ``prio``
@ -203,12 +202,11 @@ handlers may send messages via named message queues.
.. c:function:: ssize_t mq_receive(mqd_t mqdes, void *msg, size_t msglen, int *prio)
Receives the oldest of the highest
priority messages from the message queue specified by ``mqdes``. If the
size of the buffer in bytes, ``msgLen``, is less than the ``mq_msgsize``
attribute of the message queue, ``mq_receive()`` will return an error.
Otherwise, the selected message is removed from the queue and copied to
``msg``.
Receives the oldest of the highest priority messages from the message
queue specified by ``mqdes``. If the size of the buffer in bytes,
``msgLen``, is less than the ``mq_msgsize`` attribute of the message
queue, ``mq_receive()`` will return an error. Otherwise, the selected
message is removed from the queue and copied to ``msg``.
If the message queue is empty and ``O_NONBLOCK`` was not set,
``mq_receive()`` will block until a message is added to the message
@ -223,8 +221,8 @@ handlers may send messages via named message queues.
:param msg: Buffer to receive the message.
:param msglen: Size of the buffer in bytes.
:param prio: If not NULL, the location to store message priority.
:return: One success, the length of the selected message in
bytes is returned. On failure, -1 (``ERROR``) is returned and the
:return: On success, the length of the selected message in bytes is
returned. On failure, -1 (``ERROR``) is returned and the
```errno`` <#ErrnoAccess>`__ is set appropriately:
- ``EAGAIN`` The queue was empty and the ``O_NONBLOCK`` flag was set
@ -241,12 +239,11 @@ handlers may send messages via named message queues.
.. c:function:: ssize_t mq_timedreceive(mqd_t mqdes, void *msg, size_t msglen, \
int *prio, const struct timespec *abstime);
Receives the oldest of the highest
priority messages from the message queue specified by ``mqdes``. If the
size of the buffer in bytes, ``msgLen``, is less than the ``mq_msgsize``
attribute of the message queue, ``mq_timedreceive()`` will return an
error. Otherwise, the selected message is removed from the queue and
copied to ``msg``.
Receives the oldest of the highest priority messages from the message
queue specified by ``mqdes``. If the size of the buffer in bytes,
``msgLen``, is less than the ``mq_msgsize`` attribute of the message
queue, ``mq_timedreceive()`` will return an error. Otherwise, the
selected message is removed from the queue and copied to ``msg``.
If the message queue is empty and ``O_NONBLOCK`` was not set,
``mq_timedreceive()`` will block until a message is added to the message
@ -270,8 +267,8 @@ handlers may send messages via named message queues.
:param prio: If not NULL, the location to store message priority.
:param abstime: The absolute time to wait until a timeout is declared.
:return: One success, the length of the selected message in
bytes is returned. On failure, -1 (``ERROR``) is returned and the
:return: On success, the length of the selected message in bytes is
returned. On failure, -1 (``ERROR``) is returned and the
```errno`` <#ErrnoAccess>`__ is set appropriately:
- ``EAGAIN``: The queue was empty and the ``O_NONBLOCK`` flag was set
@ -289,11 +286,10 @@ handlers may send messages via named message queues.
.. c:function:: int mq_notify(mqd_t mqdes, FAR const struct sigevent *notification)
If the ``notification`` input parameter is not
``NULL``, this function connects the task with the message queue such
that the specified signal will be sent to the task whenever the message
changes from empty to non-empty. One notification can be attached to a
message queue.
If the ``notification`` input parameter is not ``NULL``, this function
connects the task with the message queue such that the specified signal
will be sent to the task whenever the message queue changes from empty
to non-empty. One notification can be attached to a message queue.
If ``notification``; is ``NULL``, the attached notification is detached
(if it was held by the calling task) and the queue is available to
@ -337,9 +333,8 @@ handlers may send messages via named message queues.
.. c:function:: int mq_setattr(mqd_t mqdes, const struct mq_attr *mqStat, \
struct mq_attr *oldMqStat);
Sets the attributes associated with the
specified message queue "mqdes." Only the "O_NONBLOCK" bit of the
"mq_flags" can be changed.
Sets the attributes associated with the specified message queue "mqdes."
Only the "O_NONBLOCK" bit of the "mq_flags" can be changed.
If ``oldMqStat`` is non-null, mq_setattr() will store the previous message
queue attributes at that location (just as would have been returned by
@ -357,8 +352,8 @@ handlers may send messages via named message queues.
.. c:function:: int mq_getattr(mqd_t mqdes, struct mq_attr *mqStat)
Gets status information and attributes
associated with the specified message queue.
Gets status information and attributes associated with the specified
message queue.
:param mqdes: Message queue descriptor
:param mqStat: Buffer in which to return attributes. The returned

View file

@ -222,9 +222,9 @@ void weak_function arm_dma_initialize(void)
* gives the caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
****************************************************************************/

View file

@ -150,9 +150,9 @@ void kinetis_dmainitialize(void);
* dir - transfer direction
*
* Returned Value:
* One success, this function returns a non-NULL, void * DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
****************************************************************************/

View file

@ -78,7 +78,7 @@ static const char g_portchar[KINETIS_NPORTS] =
*
* Description:
* Dump all GPIO registers associated with the provided pin description
* along with a descriptive messasge.
* along with a descriptive message.
*
****************************************************************************/

View file

@ -111,9 +111,9 @@ void kl_dmainitilaize(void);
* gives the caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
****************************************************************************/

View file

@ -82,7 +82,7 @@ static const char g_portchar[KL_GPIO_NPORTS] =
*
* Description:
* Dump all GPIO registers associated with the provided pin description
* along with a descriptive messasge.
* along with a descriptive message.
*
****************************************************************************/

View file

@ -495,9 +495,9 @@ void lc823450_dmareauest_dir(DMA_HANDLE handle, uint8_t dmarequest, int m2p)
* gives the caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
****************************************************************************/

View file

@ -655,9 +655,9 @@ static int lpc17_40_transmit(struct lpc17_40_driver_s *priv)
*txdesc = TXDESC_CONTROL_INT | TXDESC_CONTROL_LAST | TXDESC_CONTROL_CRC |
(priv->lp_dev.d_len - 1);
/* Copy the packet data into the Tx buffer assignd to this descriptor. It
/* Copy the packet data into the Tx buffer assigned to this descriptor. It
* should fit because each packet buffer is the MTU size and breaking up
* largerTCP messasges is handled by higher level logic. The hardware
* larger TCP message is handled by higher level logic. The hardware
* does, however, support breaking up larger messages into many fragments,
* however, that capability is not exploited here.
*

View file

@ -367,9 +367,9 @@ void lpc17_40_dmaconfigure(uint8_t dmarequest, bool alternate)
* gives the caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
****************************************************************************/

View file

@ -149,9 +149,9 @@ void lpc17_40_dmaconfigure(uint8_t dmarequest, bool alternate);
* gives the caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
****************************************************************************/

View file

@ -366,9 +366,9 @@ void lpc43_dmaconfigure(uint8_t dmarequest, uint8_t dmasrc)
* gives the caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
****************************************************************************/

View file

@ -114,9 +114,9 @@ extern "C"
* gives the caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
****************************************************************************/

View file

@ -1146,7 +1146,7 @@ static inline int lpc43_rominit(FAR struct lpc43_dev_s *priv)
* None
*
* Returned Value:
* One success, a reference to the initialized MTD device instance is
* On success, a reference to the initialized MTD device instance is
* returned; NULL is returned on any failure.
*
****************************************************************************/

View file

@ -102,7 +102,7 @@ extern "C"
* None
*
* Returned Value:
* One success, a reference to the initialized MTD device instance is
* On success, a reference to the initialized MTD device instance is
* returned; NULL is returned on any failure.
*
****************************************************************************/

View file

@ -78,7 +78,7 @@ static const char g_portchar[NUC_GPIO_NPORTS] =
*
* Description:
* Dump all GPIO registers associated with the provided pin description
* along with a descriptive messasge.
* along with a descriptive message.
*
****************************************************************************/

View file

@ -227,7 +227,7 @@ bool nuc_gpioread(gpio_cfgset_t pinset);
*
* Description:
* Dump all GPIO registers associated with the provided pin description
* along with a descriptive messasge.
* along with a descriptive message.
*
****************************************************************************/

View file

@ -78,7 +78,7 @@ static const char g_portchar[S32K1XX_NPORTS] =
*
* Description:
* Dump all GPIO registers associated with the provided pin description
* along with a descriptive messasge.
* along with a descriptive message.
*
****************************************************************************/

View file

@ -1066,13 +1066,13 @@ void weak_function arm_dma_initialize(void)
* in hardware/stm32g4xxxx_dmamux.h
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
* Assumptions:
* - The caller does not hold he DMA channel.
* - The caller can wait for the DMA channel to be freed if it is no
* - The caller can wait for the DMA channel to be freed if it is not
* available.
*
****************************************************************************/

View file

@ -2270,9 +2270,9 @@ void weak_function arm_dma_initialize(void)
* in chip/stm32h7xxxxxxx_dmamux.h
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
* Assumptions:
* - The caller does not hold he DMA channel.

View file

@ -125,9 +125,9 @@ extern "C"
* in chip/stm32h7xxxxxxx_dmamux.h
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
* Assumptions:
* - The caller does not hold he DMA channel.

View file

@ -199,9 +199,9 @@ DMA_HANDLE stm32l4_dmachannel(unsigned int chan);
* hardware/stm32l4xrxx_dmamux.h
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
* Assumptions:
* - The caller does not hold he DMA channel.

View file

@ -1022,9 +1022,9 @@ void weak_function arm_dma_initialize(void)
* in hardware/stm32l4xrxx_dmamux.h
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
* Assumptions:
* - The caller does not hold he DMA channel.

View file

@ -110,9 +110,9 @@ void xmc4_dmainitilaize(void);
* gives the caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
****************************************************************************/

View file

@ -477,9 +477,9 @@ void pic32mx_dmainitilaize(void);
* caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel handle. NULL
* is returned on any failure. This function can fail only if no DMA channel is
* available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
************************************************************************************/

View file

@ -284,9 +284,9 @@ void i486_dmainitilaize(void);
* gives the caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
* On success, this function returns a non-NULL, void* DMA channel handle.
* NULL is returned on any failure. This function can fail only if no DMA
* channel is available.
*
****************************************************************************/

View file

@ -2247,7 +2247,7 @@ CAN Usage
Only messages that have IDs that match the CONFIG_SAMA5_CANn_ADDRn when both
the received and the configured address are masked by CONFIG_SAMA5_CANn_MASKn
will be accepted. For example, if the mask is all ones, then only messasges
will be accepted. For example, if the mask is all ones, then only messages
with exact address matches will be accepted; if the mask is all zeroes than
any address will be accepted.

View file

@ -2384,7 +2384,7 @@ CAN Usage
Only messages that have IDs that match the CONFIG_SAMA5_CANn_ADDRn when both
the received and the configured address are masked by CONFIG_SAMA5_CANn_MASKn
will be accepted. For example, if the mask is all ones, then only messasges
will be accepted. For example, if the mask is all ones, then only messages
with exact address matches will be accepted; if the mask is all zeroes than
any address will be accepted.

View file

@ -27,7 +27,7 @@ boards/renesas/m16c/skp16c26/README.txt
c:\Hew3\Tools\KPIT Cummins\GNUM16CM32C-ELF\v0901\m32c-elf\bin\m32c-elf-ld.exe: BFD (GNU Binutils) 2.19-GNUM16CM32C_v0901 assertion fail /home/kpit/fsfsrc/binutils-2.19/bfd/elf32-m32c.c:482
It is possible that this error messasge my be telling me -- a very roundabout way --
It is possible that this error message may be telling me -- a very roundabout way --
that I have exceeded the FLASH region, but I think that unlikely (it is difficult
to know if the link does not complete gracefully).

View file

@ -490,7 +490,7 @@ extern "C"
* fontid: Identifies the font set to get
*
* Returned Value:
* One success, a non-NULL font handle is returned.
* On success, a non-NULL font handle is returned.
*
****************************************************************************/
@ -638,7 +638,7 @@ void nxf_cache_disconnect(FCACHE fhandle);
* Zero (OK) is returned if the metrics were
*
* Returned Value:
* One success, a non-NULL font handle is returned.
* On success, a non-NULL font handle is returned.
*
****************************************************************************/

View file

@ -47,7 +47,7 @@
* TASK A TASK B
* nxsem_init(sem, 0, 0);
* nxsem_wait(sem);
* snxem_post(sem);
* nxsem_post(sem);
* Awakens as holder
*
* In this case priority inheritance can interfere with the operation of

View file

@ -42,7 +42,7 @@
* tp - Pointer to the time to be converted.
*
* Returned Value:
* One success a pointer to the string is returned; on failure, NULL is
* On success, a pointer to the string is returned; on failure, NULL is
* returned.
*
****************************************************************************/

View file

@ -63,7 +63,7 @@ static const char * const g_mon_name[12] =
* buf - A user provided buffer to receive the 26 character time string.
*
* Returned Value:
* One success, the pointer to the 'buf' is returned; on failure, NULL is
* On success, the pointer to the 'buf' is returned; on failure, NULL is
* returned.
*
****************************************************************************/

View file

@ -42,7 +42,7 @@
* timep - The current time represented as seconds since the epoch.
*
* Returned Value:
* One success a pointer to the string is returned; on failure, NULL is
* On success, a pointer to the string is returned; on failure, NULL is
* returned.
*
****************************************************************************/

View file

@ -47,7 +47,7 @@
* buf - A user provided buffer to receive the 26 character time string.
*
* Returned Value:
* One success, the pointer to the 'buf' is returned; on failure, NULL is
* On success, the pointer to the 'buf' is returned; on failure, NULL is
* returned.
*
****************************************************************************/

View file

@ -878,7 +878,7 @@ void nxf_cache_disconnect(FCACHE fhandle)
* Zero (OK) is returned if the metrics were
*
* Returned Value:
* One success, a non-NULL font handle is returned.
* On success, a non-NULL font handle is returned.
*
****************************************************************************/

View file

@ -114,7 +114,7 @@ mq_msgblockalloc(FAR sq_queue_t *queue, uint16_t nmsgs,
* Name: nxmq_initialize
*
* Description:
* This function initializes the messasge system. This function must
* This function initializes the message system. This function must
* be called early in the initialization sequence before any of the
* other message interfaces execute.
*

View file

@ -59,7 +59,7 @@
* msglen - Size of the buffer in bytes
*
* Returned Value:
* One success, zero (OK) is returned. A negated errno value is returned
* On success, zero (OK) is returned. A negated errno value is returned
* on any failure:
*
* EPERM Message queue opened not opened for reading.
@ -108,7 +108,7 @@ int nxmq_verify_receive(FAR struct mqueue_inode_s *msgq,
* received message.
*
* Returned Value:
* One success, zero (OK) is returned. A negated errno value is returned
* On success, zero (OK) is returned. A negated errno value is returned
* on any failure.
*
* Assumptions:

View file

@ -203,7 +203,7 @@ ssize_t nxmq_receive(mqd_t mqdes, FAR char *msg, size_t msglen,
* prio - If not NULL, the location to store message priority.
*
* Returned Value:
* One success, the length of the selected message in bytes is returned.
* On success, the length of the selected message in bytes is returned.
* On failure, -1 (ERROR) is returned and the errno is set appropriately:
*
* EAGAIN The queue was empty, and the O_NONBLOCK flag was set

View file

@ -62,7 +62,7 @@
* prio - The priority of the message
*
* Returned Value:
* One success, 0 (OK) is returned. On failure, a negated errno value is
* On success, 0 (OK) is returned. On failure, a negated errno value is
* returned.
*
* EINVAL Either msg or msgq is NULL or the value of prio is invalid.

View file

@ -336,7 +336,7 @@ ssize_t nxmq_timedreceive(mqd_t mqdes, FAR char *msg, size_t msglen,
* abstime - the absolute time to wait until a timeout is declared.
*
* Returned Value:
* One success, the length of the selected message in bytes is returned.
* On success, the length of the selected message in bytes is returned.
* On failure, -1 (ERROR) is returned and the errno is set appropriately:
*
* EAGAIN The queue was empty, and the O_NONBLOCK flag was set