mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
05f114d0af
- most were trivial
- missing group close or open
- extra space
- no doxygen comment
- name commad might open an implicit group
this hould also be implicit cosed but does not happen somtimes
- crazy: internal declared groups have to be closed internal
88 lines
2.6 KiB
C
88 lines
2.6 KiB
C
/*
|
|
* Copyright (C) 2019 Hamburg University of Applied Sciences
|
|
* 2020 Inria
|
|
*
|
|
* This file is subject to the terms and conditions of the GNU Lesser
|
|
* General Public License v2.1. See the file LICENSE in the top level
|
|
* directory for more details.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup pkg_openwsn
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief RIOT adaption of the "radio" bsp module definitions
|
|
*
|
|
* The radio adaptation runs in an own thread with the highest priority
|
|
* (`THREAD_PRIORITY_MAIN - 4`) and maps to RIOT's `netdev` API.
|
|
*
|
|
* Hardware MAC layer features such as CSMA/CA, ACK handling and retransmissions
|
|
* are handled by OpenWSN, so the radio driver must support disabling AUTOACK
|
|
* and CSMA handling by the hardware. Frame filtering must as well be disabled.
|
|
*
|
|
* The radio adaptation preloads the buffer so `NETOPT_PRELOADING` must be
|
|
* supported.
|
|
*
|
|
* OpenWSN needs to be notified when a frame reception/transmission stats and
|
|
* when it ends. Therefore radio drivers need to support the following netdev
|
|
* events:
|
|
*
|
|
* - `NETDEV_EVENT_RX_STARTED`
|
|
* - `NETDEV_EVENT_TX_STARTED`
|
|
* - `NETDEV_EVENT_RX_COMPLETE`
|
|
* - `NETDEV_EVENT_TX_COMPLETE`
|
|
*
|
|
* OpenWSN expects to recover crc information on every received frame even if it
|
|
* will simply drop frames with invalid crc. The stack can function correctly if
|
|
* radio drivers automatically drop frames with an invalid crc (i.e. the stack
|
|
* doesn't get notified about these frames), but it might print the following
|
|
* error if using `openwsn_serial`:
|
|
*
|
|
* - `[IEEE802154E] wdDataDuration overflows while at state 19 in slotOffset 0`
|
|
*
|
|
* @author Peter Kietzmann <peter.kietzmann@haw-hamburg.de>, April 2019
|
|
* @author Francisco Molina <francois-xavier.molina@inria.fr>
|
|
*/
|
|
|
|
#ifndef OPENWSN_RADIO_H
|
|
#define OPENWSN_RADIO_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "net/netdev.h"
|
|
#include "net/ieee802154/radio.h"
|
|
#include "radio.h"
|
|
|
|
/**
|
|
* @brief Initialize OpenWSN radio
|
|
*
|
|
* @param[in] radio_dev pointer to a dev interface
|
|
*
|
|
* @return PID of OpenWSN thread
|
|
* @return -1 on initialization error
|
|
*/
|
|
int openwsn_radio_init(void *radio_dev);
|
|
|
|
/**
|
|
* @brief OpenWSN radio variables structure
|
|
*/
|
|
typedef struct {
|
|
#if IS_ACTIVE(MODULE_OPENWSN_RADIO_NETDEV)
|
|
netdev_t *dev; /**< netdev device */
|
|
#else
|
|
ieee802154_dev_t *dev; /**< radio hal */
|
|
#endif
|
|
radio_capture_cbt startFrame_cb; /**< start of frame capture callback */
|
|
radio_capture_cbt endFrame_cb; /**< end of frame capture callback */
|
|
} openwsn_radio_t;
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* OPENWSN_RADIO_H */
|
|
/** @} */
|