6057960331
* 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.
243 lines
10 KiB
C
243 lines
10 KiB
C
/****************************************************************************
|
|
* include/nuttx/net/radiodev.h
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership. The
|
|
* ASF licenses this file to you 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_NET_RADIODEV_H
|
|
#define __INCLUDE_NUTTX_NET_RADIODEV_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <nuttx/net/netdev.h>
|
|
|
|
#if defined(CONFIG_NET_6LOWPAN) || defined(CONFIG_NET_BLUETOOTH) || \
|
|
defined (CONFIG_NET_IEEE802154)
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
/* Different packet radios may have different properties. If there are
|
|
* multiple packet radios, then those properties have to be queried at
|
|
* run time. This information is provided to the 6LoWPAN network via the
|
|
* following structure.
|
|
*/
|
|
|
|
struct radiodev_properties_s
|
|
{
|
|
uint8_t sp_addrlen; /* Length of an address */
|
|
uint8_t sp_framelen; /* Fixed packet/frame size (up to 255) */
|
|
struct netdev_varaddr_s sp_mcast; /* Multicast address */
|
|
struct netdev_varaddr_s sp_bcast; /* Broadcast address */
|
|
#ifdef CONFIG_NET_STARPOINT
|
|
struct netdev_varaddr_s sp_hubnode; /* Address of the hub node in a star */
|
|
#endif
|
|
};
|
|
|
|
/* The device structure for radio network device differs from the standard
|
|
* Ethernet MAC device structure. The main reason for this difference is
|
|
* that fragmentation must be supported.
|
|
*
|
|
* The radio network driver does not use the d_buf packet buffer directly.
|
|
* Rather, it uses a list smaller frame buffers.
|
|
*
|
|
* - Outgoing frame data is provided in an IOB via the r_req_data()
|
|
* interface method each time that the radio needs to send more data.
|
|
* The length of the frame is provided in the io_len field of the IOB.
|
|
*
|
|
* Outgoing frames are generated when the radio network driver calls
|
|
* the devif_poll(), sixlowpan_input(), or ieee802154_input()
|
|
* interfaces. In each case, the radio driver must provide a working
|
|
* buffer in the d_buf pointer. A special form of the packet buffer
|
|
* must be used, struct sixlowpan_reassbuf_s. This special form
|
|
* includes appended data for managing reassembly of packets.
|
|
*
|
|
* - Received frames are provided by radio network driver to the network
|
|
* via an IOB parameter in the sixlowpan_input() or ieee802154_input()
|
|
* interfaces. The length of the frame is io_len.
|
|
*
|
|
* Again, the radio network driver must provide an instance of struct
|
|
* sixlowpan_reassbuf_s as the packet buffer in the d_buf field. This
|
|
* driver-provided data will only be used if the receive frames are
|
|
* not fragmented.
|
|
*
|
|
* - Received 6LoWPAN frames will be uncompressed and possibly
|
|
* reassembled in the d_buf; d_len will hold the size of the
|
|
* reassembled packet.
|
|
*
|
|
* For fragmented frames, d_buf provided by radio driver will not be
|
|
* used. 6LoWPAN must handle multiple reassemblies from different
|
|
* sources simultaneously. To support this, 6LoWPAN will allocate a
|
|
* unique reassembly buffer for each active reassembly, based on the
|
|
* reassembly tag and source radio address. These reassembly buffers
|
|
* are managed entirely by the 6LoWPAN layer.
|
|
*
|
|
* This is accomplished by "inheriting" the standard 'struct net_driver_s'
|
|
* and appending the frame buffer as well as other metadata needed to
|
|
* manage the fragmentation. 'struct radio_driver_s' is cast
|
|
* compatible with 'struct net_driver_s' when dev->d_lltype ==
|
|
* NET_LL_IEEE802154 or dev->d_lltype == NET_LL_PKTRADIO.
|
|
*
|
|
* The radio network driver has responsibility for initializing this
|
|
* 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
|
|
* structure along with its (single) reassembly buffer provided at
|
|
* d_buf. During the course of the poll, the networking layer may
|
|
* generate outgoing frames. These frames will by provided to the
|
|
* radio network driver via the req_data() method.
|
|
*
|
|
* After sending each frame through the radio, the MAC driver must
|
|
* return the frame to the pool of free IOBs using the iob_free().
|
|
*
|
|
* 2. When receiving data both buffers must be provided for 6LoWPAN
|
|
* frames; PF_IEEE802154 frames do not require the d_buf.
|
|
*
|
|
* The radio driver should receive the frame data directly into the
|
|
* payload area of an IOB frame structure. That IOB structure may be
|
|
* obtained using the iob_alloc() function.
|
|
*
|
|
* For 6LoWPAN, fragmented packets will be reassembled using allocated
|
|
* reassembly buffers that are managed by the 6LoWPAN layer. The radio
|
|
* driver must still provide its (single) reassembly buffer in d_buf;
|
|
* that buffer is still used for the case where the packet is not
|
|
* fragmented into many frames. In either case, the packet buffer will
|
|
* have a size of advertised MTU of the protocol,
|
|
* CONFIG_NET_6LOWPAN_PKTSIZE, plus CONFIG_NET_GUARDSIZE and some
|
|
* additional overhead for reassembly state data.
|
|
*
|
|
* The radio network driver should then inform the network of the receipt
|
|
* of a frame by calling sixlowpan_input() or ieee802154_input(). That
|
|
* single frame (or, perhaps, list of frames) should be provided as
|
|
* second argument of that call.
|
|
*
|
|
* The network will free the IOB by calling iob_free after it has
|
|
* processed the incoming frame. As a complexity, the result of
|
|
* receiving a frame may be that the network may respond provide an
|
|
* outgoing frames in the via a nested call to the req_data() method.
|
|
*/
|
|
|
|
struct iob_s; /* Forward reference */
|
|
|
|
struct radio_driver_s
|
|
{
|
|
/* This definition must appear first in the structure definition to
|
|
* assure cast compatibility.
|
|
*/
|
|
|
|
struct net_driver_s r_dev;
|
|
|
|
/* Radio network driver-specific definitions follow. */
|
|
|
|
#ifdef CONFIG_WIRELESS_IEEE802154
|
|
/* 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
|
|
* three places:
|
|
*
|
|
* 1. When you do that data request
|
|
* 2. When the transmission is complete, the conf_data is called with
|
|
* that handle so that the user can be notified of the frame's success/
|
|
* failure
|
|
* 3. For a req_purge, to basically "cancel" the transaction. This is
|
|
* often particularly useful on a coordinator that has indirect data
|
|
* waiting to be requested from another device
|
|
*
|
|
* Here is a simple frame counter.
|
|
*/
|
|
|
|
uint8_t r_msdu_handle;
|
|
#endif
|
|
|
|
/* MAC network driver callback functions **********************************/
|
|
|
|
/**************************************************************************
|
|
* Name: r_get_mhrlen
|
|
*
|
|
* Description:
|
|
* Calculate the MAC header length given the frame meta-data.
|
|
*
|
|
* Input Parameters:
|
|
* netdev - The network device that will mediate the MAC interface
|
|
* meta - Obfuscated metadata structure needed to recreate the
|
|
* radio MAC header
|
|
*
|
|
* Returned Value:
|
|
* A non-negative MAC header length is returned on success; a negated
|
|
* errno value is returned on any failure.
|
|
*
|
|
**************************************************************************/
|
|
|
|
CODE int (*r_get_mhrlen)(FAR struct radio_driver_s *netdev,
|
|
FAR const void *meta);
|
|
|
|
/**************************************************************************
|
|
* Name: r_req_data
|
|
*
|
|
* Description:
|
|
* Requests the transfer of a list of frames to the MAC.
|
|
*
|
|
* Input Parameters:
|
|
* netdev - The network device that will mediate the MAC interface
|
|
* meta - Obfuscated metadata structure needed to create the radio
|
|
* MAC header
|
|
* framelist - Head of a list of frames to be transferred.
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) returned on success; a negated errno value is returned on
|
|
* any failure.
|
|
*
|
|
**************************************************************************/
|
|
|
|
CODE int (*r_req_data)(FAR struct radio_driver_s *netdev,
|
|
FAR const void *meta, FAR struct iob_s *framelist);
|
|
|
|
/**************************************************************************
|
|
* Name: r_properties
|
|
*
|
|
* Description:
|
|
* Different packet radios may have different properties. If there are
|
|
* multiple packet radios, then those properties have to be queried at
|
|
* run time. This information is provided to the 6LoWPAN network via the
|
|
* following structure.
|
|
*
|
|
* Input Parameters:
|
|
* netdev - The network device to be queried
|
|
* properties - Location where radio properties will be returned.
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) returned on success; a negated errno value is returned on
|
|
* any failure.
|
|
*
|
|
**************************************************************************/
|
|
|
|
CODE int (*r_properties)(FAR struct radio_driver_s *netdev,
|
|
FAR struct radiodev_properties_s *properties);
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#endif /* CONFIG_NET_6LOWPAN || CONFIG_NET_BLUETOOTH || CONFIG_NET_IEEE802154 */
|
|
#endif /* __INCLUDE_NUTTX_NET_RADIODEV_H */
|