sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix mistakes in comments and docs

Browse Source 
* drivers/wireless/bluetooth/bt_null.c: Fix misleading comment

* drivers/wireless/spirit/Kconfig: Fix incorrect word (absolution).

* drivers/wireless/spirit/drivers/Kconfig: Fix wrong name (TMicro->STMicro)

* drivers/wireless/spirit/drivers/spirit_netdev.c: Fix wrong word
  (verify->very).

* drivers/wireless/spirit/drivers/spirit_netdev.c: Fix double "the" and typo.

* include/nuttx/net/radiodev.h: Fix various typos and errors.
This commit is contained in:
Nathan Hartman 2022-06-26 15:40:32 -04:00 committed by Xiang Xiao
parent f3dbc7bc63
commit 6057960331
5 changed files with 26 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
drivers/wireless/bluetooth/bt_null.c
View File

@ -18,7 +18,7 @@
* *
****************************************************************************/ ****************************************************************************/
/* UART based Bluetooth driver */ /* NULL (do-nothing) Bluetooth driver */
/**************************************************************************** /****************************************************************************
* Included Files * Included Files

2
drivers/wireless/spirit/Kconfig
View File

@ -18,7 +18,7 @@ config WL_SPIRIT_SPIFREQUENCY
default 10000000 default 10000000
---help--- ---help---
Frequency at which to operate the SPI interface to the Spirit part. Frequency at which to operate the SPI interface to the Spirit part.
The default is the absolution maximum and you may likely have to The default is the absolute maximum and you may likely have to
reduce this for your board. reduce this for your board.
config WL_SPIRIT_REGDEBUG config WL_SPIRIT_REGDEBUG

2
drivers/wireless/spirit/drivers/Kconfig
View File

@ -9,7 +9,7 @@ config SPIRIT_NETDEV
select WL_SPIRIT select WL_SPIRIT
select ARCH_HAVE_NETDEV_STATISTICS select ARCH_HAVE_NETDEV_STATISTICS
---help--- ---help---
This selection enables support for the TMicro Spirit1-based device. This selection enables support for the STMicro Spirit1-based device.
This configuration generates an IEEE802.15.4 work-alike radio device that This configuration generates an IEEE802.15.4 work-alike radio device that
works with the 6LoWPAN stack. works with the 6LoWPAN stack.

6
drivers/wireless/spirit/drivers/spirit_netdev.c
View File

@ -33,7 +33,7 @@
* input of all frames into the network, (2) queuing of all output frames, * input of all frames into the network, (2) queuing of all output frames,
* and all network housekeeping such as periodic polling. * and all network housekeeping such as periodic polling.
* *
* Interrupt handling is verify brief since it only schedules the interrupt * Interrupt handling is very brief since it only schedules the interrupt
* work to occur on the HP work queue. Several things are done for the * work to occur on the HP work queue. Several things are done for the
* interrupt handling, but the primary things are: (1) receipt of incoming * interrupt handling, but the primary things are: (1) receipt of incoming
* packets, and (2) handling of the completion of TX transfers. * packets, and (2) handling of the completion of TX transfers.
@ -81,9 +81,9 @@
* size * size
* *
* Another consideration is the nature of the GPIO interrupts. For STM32, * Another consideration is the nature of the GPIO interrupts. For STM32,
* for example, disabling the Spirit interrupt tears down the the entire * for example, disabling the Spirit interrupt tears down the entire
* interrupt setup so, for example, any interrupts that are received while * interrupt setup so, for example, any interrupts that are received while
* interrupts are disable, aka torn down, will be lost. Hence, it may be * interrupts are disabled, aka torn down, will be lost. Hence, it may be
* necessary to process pending interrupts whenever interrupts are re- * necessary to process pending interrupts whenever interrupts are re-
* enabled. * enabled.
*/ */

41
include/nuttx/net/radiodev.h
View File

@ -62,32 +62,31 @@ struct radiodev_properties_s
* The radio network driver does not use the d_buf packet buffer directly. * The radio network driver does not use the d_buf packet buffer directly.
* Rather, it uses a list smaller frame buffers. * Rather, it uses a list smaller frame buffers.
* *
* - Outgoing frame data is provided in an IOB in the via the * - Outgoing frame data is provided in an IOB via the r_req_data()
* r_req_data() interface method each time that the radio needs to * interface method each time that the radio needs to send more data.
* send more data. The length of the frame is provided in the io_len * The length of the frame is provided in the io_len field of the IOB.
* field of the IOB.
* *
* Outgoing frames are generated when the radio network driver calls * Outgoing frames are generated when the radio network driver calls
* the devif_poll(), sixlowpan_input(), or ieee802154_input() * the devif_poll(), sixlowpan_input(), or ieee802154_input()
* interfaces. In each case, the radio driver must provide a working * interfaces. In each case, the radio driver must provide a working
* buffer in the d_buf pointer. A special form of the packet buffer * buffer in the d_buf pointer. A special form of the packet buffer
* must be used, struct sixlowpan_reassbuf_s. This special for * must be used, struct sixlowpan_reassbuf_s. This special form
* includes appended data for managing reassembly of packets. * includes appended data for managing reassembly of packets.
* *
* - Received frames are provided by radio network driver to the network * - Received frames are provided by radio network driver to the network
* via an IOB parameter in the sixlowpan_input() pr ieee802154_input() * via an IOB parameter in the sixlowpan_input() or ieee802154_input()
* interface. The length of the frame is io_len. * interfaces. The length of the frame is io_len.
* *
* Again, the radio network driver must provide an instance of struct * Again, the radio network driver must provide an instance of struct
* sixlowpan_reassbuf_s as the packet buffer in the d_buf field. This * sixlowpan_reassbuf_s as the packet buffer in the d_buf field. This
* driver-provided data will only be used if the the receive frames are * driver-provided data will only be used if the receive frames are
* not fragmented. * not fragmented.
* *
* - Received 6LoWPAN frames and will be uncompressed and possibly * - Received 6LoWPAN frames will be uncompressed and possibly
* reassembled in resassembled the d_buf; d_len will hold the size of * reassembled in the d_buf; d_len will hold the size of the
* the reassembled packet. * reassembled packet.
* *
* For fagemented frames, d_buf provided by radio driver will not be * For fragmented frames, d_buf provided by radio driver will not be
* used. 6LoWPAN must handle multiple reassemblies from different * used. 6LoWPAN must handle multiple reassemblies from different
* sources simultaneously. To support this, 6LoWPAN will allocate a * sources simultaneously. To support this, 6LoWPAN will allocate a
* unique reassembly buffer for each active reassembly, based on the * unique reassembly buffer for each active reassembly, based on the
@ -104,10 +103,10 @@ struct radiodev_properties_s
* structure. In general, all fields must be set to NULL. In addition: * structure. In general, all fields must be set to NULL. In addition:
* *
* 1. On a TX poll, the radio network driver should provide its driver * 1. On a TX poll, the radio network driver should provide its driver
* structure along is (single) reassemby buffer provided at d_buf. * structure along with its (single) reassembly buffer provided at
* During the course of the poll, the networking layer may generate * d_buf. During the course of the poll, the networking layer may
* outgoing frames. These frames will by provided to the radio network * generate outgoing frames. These frames will by provided to the
* driver via the req_data() method. * radio network driver via the req_data() method.
* *
* After sending each frame through the radio, the MAC driver must * After sending each frame through the radio, the MAC driver must
* return the frame to the pool of free IOBs using the iob_free(). * return the frame to the pool of free IOBs using the iob_free().
@ -128,7 +127,7 @@ struct radiodev_properties_s
* CONFIG_NET_6LOWPAN_PKTSIZE, plus CONFIG_NET_GUARDSIZE and some * CONFIG_NET_6LOWPAN_PKTSIZE, plus CONFIG_NET_GUARDSIZE and some
* additional overhead for reassembly state data. * additional overhead for reassembly state data.
* *
* The radio network driver should then inform the network of the recipt * The radio network driver should then inform the network of the receipt
* of a frame by calling sixlowpan_input() or ieee802154_input(). That * of a frame by calling sixlowpan_input() or ieee802154_input(). That
* single frame (or, perhaps, list of frames) should be provided as * single frame (or, perhaps, list of frames) should be provided as
* second argument of that call. * second argument of that call.
@ -154,11 +153,11 @@ struct radio_driver_s
#ifdef CONFIG_WIRELESS_IEEE802154 #ifdef CONFIG_WIRELESS_IEEE802154
/* The msdu_handle is basically an id for the frame. The standard just /* The msdu_handle is basically an id for the frame. The standard just
* says that the next highest layer should determine it. It is used in * says that the next highest layer should determine it. It is used in
* three places * three places:
* *
* 1. When you do that data request * 1. When you do that data request
* 2. When the transmission is complete, the conf_data is called with * 2. When the transmission is complete, the conf_data is called with
* that handle so that the user can be notified of the frames success/ * that handle so that the user can be notified of the frame's success/
* failure * failure
* 3. For a req_purge, to basically "cancel" the transaction. This is * 3. For a req_purge, to basically "cancel" the transaction. This is
* often particularly useful on a coordinator that has indirect data * often particularly useful on a coordinator that has indirect data
@ -179,12 +178,12 @@ struct radio_driver_s
* Calculate the MAC header length given the frame meta-data. * Calculate the MAC header length given the frame meta-data.
* *
* Input Parameters: * Input Parameters:
* netdev - The networkd device that will mediate the MAC interface * netdev - The network device that will mediate the MAC interface
* meta - Obfuscated metadata structure needed to recreate the * meta - Obfuscated metadata structure needed to recreate the
* radio MAC header * radio MAC header
* *
* Returned Value: * Returned Value:
* A non-negative MAC headeer length is returned on success; a negated * A non-negative MAC header length is returned on success; a negated
* errno value is returned on any failure. * errno value is returned on any failure.
* *
**************************************************************************/ **************************************************************************/