Merge pull request #2825 from haukepetersen/opt_driver_rf2xx

drivers: new driver for at86rf2xx radios

Makefile.dep

@@ -201,3 +201,7 @@ ifneq (,$(filter oonf_common,$(USEMODULE)))
   USEPKG += oonf_api
   USEMODULE += socket_base
 endif
+
+ifneq (,$(filter ng_at86rf2%,$(USEMODULE)))
+  USEMODULE += ng_at86rf2xx
+endif

Makefile.pseudomodules

@@ -3,3 +3,7 @@ PSEUDOMODULES += transport_layer
 PSEUDOMODULES += ng_ipv6_router
 PSEUDOMODULES += pktqueue
 PSEUDOMODULES += ng_netbase
+
+# include variants of the AT86RF2xx drivers as pseudo modules
+PSEUDOMODULES += ng_at86rf23%
+PSEUDOMODULES += ng_at86rf21%

drivers/Makefile.include

@@ -13,6 +13,9 @@ endif
 ifneq (,$(filter at86rf231,$(USEMODULE)))
     USEMODULE_INCLUDES += $(RIOTBASE)/drivers/at86rf231/include
 endif
+ifneq (,$(filter ng_at86rf2xx,$(USEMODULE)))
+    USEMODULE_INCLUDES += $(RIOTBASE)/drivers/ng_at86rf2xx/include
+endif
 ifneq (,$(filter isl29020,$(USEMODULE)))
     USEMODULE_INCLUDES += $(RIOTBASE)/drivers/isl29020/include
 endif

drivers/include/ng_at86rf2xx.h

@@ -0,0 +1,366 @@
+/*
+ * Copyright (C) 2015 Freie Universität Berlin
+ *
+ * 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.
+ */
+
+/**
+ * @defgroup    drivers_ng_at86rf2xx AT86RF2xx based drivers
+ * @ingroup     drivers
+ *
+ * This module contains drivers for radio devices in Atmel's AT86RF2xx series.
+ * The driver is aimed to work with all devices of this series.
+ *
+ * @{
+ *
+ * @file
+ * @brief       Interface definition for AT86RF2xx based drivers
+ *
+ * @author      Thomas Eichinger <[email protected]>
+ * @author      Hauke Petersen <[email protected]>
+ * @author      Kaspar Schleiser <[email protected]>
+ */
+
+#ifndef NG_AT86RF2XX_H_
+#define NG_AT86RF2XX_H_
+
+#include <stdint.h>
+
+#include "board.h"
+#include "periph/spi.h"
+#include "periph/gpio.h"
+#include "net/ng_netdev.h"
+#include "ng_at86rf2xx.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief   Maximum possible packet size in byte
+ */
+#define NG_AT86RF2XX_MAX_PKT_LENGTH     (127)
+
+/**
+ * @brief   Default addresses used if the CPUID module is not present
+ * @{
+ */
+#define NG_AT86RF2XX_DEFAULT_ADDR_SHORT (0x0230)
+#define NG_AT86RF2XX_DEFAULT_ADDR_LONG  (0x1222334455667788)
+/** @} */
+
+/**
+  * @brief   Channel configuration
+  * @{
+  */
+#ifdef MODULE_NG_AT86RF212B
+/* the AT86RF212B has a sub-1GHz radio */
+#define NG_AT86RF2XX_MIN_CHANNEL        (0)
+#define NG_AT86RF2XX_MAX_CHANNEL        (10)
+#define NG_AT86RF2XX_DEFAULT_CHANNEL    (5)
+#else
+#define NG_AT86RF2XX_MIN_CHANNEL        (11U)
+#define NG_AT86RF2XX_MAX_CHANNEL        (26U)
+#define NG_AT86RF2XX_DEFAULT_CHANNEL    (17U)
+#endif
+/** @} */
+
+/**
+ * @brief   Default PAN ID
+ *
+ * TODO: Read some global network stack specific configuration value
+ */
+#define NG_AT86RF2XX_DEFAULT_PANID      (0x0023)
+
+/**
+ * @brief   Default TX power (0dBm)
+ */
+#define NG_AT86RF2XX_DEFAULT_TXPOWER    (0U)
+
+/**
+ * @brief   Flags for device internal states (see datasheet)
+ * @{
+ */
+#define NG_AT86RF2XX_STATE_TRX_OFF      (0x08)  /**< idle */
+#define NG_AT86RF2XX_STATE_PLL_ON       (0x09)  /**< ready to transmit */
+#define NG_AT86RF2XX_STATE_SLEEP        (0x0f)  /**< sleep mode */
+#define NG_AT86RF2XX_STATE_BUSY_RX_AACK (0x11)  /**< busy receiving data */
+#define NG_AT86RF2XX_STATE_BUSY_TX_ARET (0x12)  /**< busy transmitting data */
+#define NG_AT86RF2XX_STATE_RX_AACK_ON   (0x16)  /**< wait for incoming data */
+#define NG_AT86RF2XX_STATE_TX_ARET_ON   (0x19)  /**< ready for sending data */
+#define NG_AT86RF2XX_STATE_IN_PROGRESS  (0x1f)  /**< ongoing state conversion */
+/** @} */
+
+/**
+ * @brief   Internal device option flags
+ * @{
+ */
+#define NG_AT86RF2XX_OPT_AUTOACK        (0x0001)    /**< auto ACKs active */
+#define NG_AT86RF2XX_OPT_CSMA           (0x0002)    /**< CSMA active */
+#define NG_AT86RF2XX_OPT_PROMISCUOUS    (0x0004)    /**< promiscuous mode
+                                                     *   active */
+#define NG_AT86RF2XX_OPT_PRELOADING     (0x0008)    /**< preloading enabled */
+#define NG_AT86RF2XX_OPT_TELL_TX_START  (0x0010)    /**< notify MAC layer on TX
+                                                     *   start */
+#define NG_AT86RF2XX_OPT_TELL_TX_END    (0x0020)    /**< notify MAC layer on TX
+                                                     *   finished */
+#define NG_AT86RF2XX_OPT_TELL_RX_START  (0x0040)    /**< notify MAC layer on RX
+                                                     *   start */
+#define NG_AT86RF2XX_OPT_TELL_RX_END    (0x0080)    /**< notify MAC layer on RX
+                                                     *   finished */
+#define NG_AT86RF2XX_OPT_RAWDUMP        (0x0100)    /**< pass RAW frame data to
+                                                     *   upper layer */
+#define NG_AT86RF2XX_OPT_SRC_ADDR_LONG  (0x0200)    /**< send data using long
+                                                     *   source address */
+#define NG_AT86RF2XX_OPT_USE_SRC_PAN    (0x0400)    /**< do not compress source
+                                                     *   PAN ID */
+/** @} */
+
+/**
+ * @brief   Device descriptor for AT86RF2XX radio devices
+ */
+typedef struct {
+    /* netdev fields */
+    const ng_netdev_driver_t *driver;   /**< pointer to the devices interface */
+    ng_netdev_event_cb_t event_cb;      /**< netdev event callback */
+    kernel_pid_t mac_pid;               /**< the driver's thread's PID */
+    /* device specific fields */
+    spi_t spi;                          /**< used SPI device */
+    gpio_t cs_pin;                      /**< chip select pin */
+    gpio_t sleep_pin;                   /**< sleep pin */
+    gpio_t reset_pin;                   /**< reset pin */
+    gpio_t int_pin;                     /**< external interrupt pin */
+    ng_nettype_t proto;                 /**< protocol the radio expects */
+    uint8_t state;                      /**< current state of the radio */
+    uint8_t seq_nr;                     /**< sequence number to use next */
+    uint8_t frame_len;                  /**< length of the current TX frame */
+    uint16_t pan;                       /**< currently used PAN ID */
+    uint8_t addr_short[2];              /**< the radio's short address */
+    uint8_t addr_long[8];               /**< the radio's long address */
+    uint16_t options;                   /**< state of used options */
+    uint8_t idle_state;                 /**< state to return to after sending */
+} ng_at86rf2xx_t;
+
+
+/**
+ * @brief   Initialize a given AT86RF2xx device
+ *
+ * @param[out] dev          device descriptor
+ * @param[in] spi           SPI bus the device is connected to
+ * @param[in] spi_speed     SPI speed to use
+ * @param[in] cs_pin        GPIO pin connected to chip select
+ * @param[in] int_pin       GPIO pin connected to the interrupt pin
+ * @param[in] sleep_pin     GPIO pin connected to the sleep pin
+ * @param[in] reset_pin     GPIO pin connected to the reset pin
+ *
+ * @return                  0 on success
+ * @return                  <0 on error
+ */
+int ng_at86rf2xx_init(ng_at86rf2xx_t *dev, spi_t spi, spi_speed_t spi_speed,
+                      gpio_t cs_pin, gpio_t int_pin,
+                      gpio_t sleep_pin, gpio_t reset_pin);
+
+/**
+ * @brief   Trigger a hardware reset and configure radio with default values
+ *
+ * @param[in] dev           device to reset
+ */
+void ng_at86rf2xx_reset(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Trigger a clear channel assessment
+ *
+ * @param[in] dev           device to use
+ *
+ * @return                  true if channel is clear
+ * @return                  false if channel is busy
+ */
+bool ng_at86rf2xx_cca(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Get the short address of the given device
+ *
+ * @param[in] dev           device to read from
+ *
+ * @return                  the currently set (2-byte) short address
+ */
+uint16_t ng_at86rf2xx_get_addr_short(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Set the short address of the given device
+ *
+ * @param[in] dev           device to write to
+ * @param[in] addr          (2-byte) short address to set
+ */
+void ng_at86rf2xx_set_addr_short(ng_at86rf2xx_t *dev, uint16_t addr);
+
+/**
+ * @brief   Get the configured long address of the given device
+ *
+ * @param[in] dev           device to read from
+ *
+ * @return                  the currently set (8-byte) long address
+ */
+uint64_t ng_at86rf2xx_get_addr_long(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Set the long address of the given device
+ *
+ * @param[in] dev           device to write to
+ * @param[in] addr          (8-byte) long address to set
+ */
+void ng_at86rf2xx_set_addr_long(ng_at86rf2xx_t *dev, uint64_t addr);
+
+/**
+ * @brief   Get the configured channel of the given device
+ *
+ * @param[in] dev           device to read from
+ *
+ * @return                  the currently set channel
+ */
+uint8_t ng_at86rf2xx_get_chan(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Set the channel of the given device
+ *
+ * @param[in] dev           device to write to
+ * @param[in] chan          channel to set
+ */
+void ng_at86rf2xx_set_chan(ng_at86rf2xx_t *dev, uint8_t chan);
+
+/**
+ * @brief   Get the configured PAN ID of the given device
+ *
+ * @param[in] dev           device to read from
+ *
+ * @return                  the currently set PAN ID
+ */
+uint16_t ng_at86rf2xx_get_pan(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Set the PAN ID of the given device
+ *
+ * @param[in] dev           device to write to
+ * @param[in] pan           PAN ID to set
+ */
+void ng_at86rf2xx_set_pan(ng_at86rf2xx_t *dev, uint16_t pan);
+
+/**
+ * @brief   Get the configured transmission power of the given device [in dBm]
+ *
+ * @param[in] dev           device to read from
+ *
+ * @return                  configured transmission power in dBm
+ */
+int16_t ng_at86rf2xx_get_txpower(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Set the transmission power of the given device [in dBm]
+ *
+ * If the device does not support the exact dBm value given, it will set a value
+ * as close as possible to the given value. If the given value is larger or
+ * lower then the maximal or minimal possible value, the min or max value is
+ * set, respectively.
+ *
+ * @param[in] dev           device to write to
+ * @param[in] txpower       transmission power in dBm
+ */
+void ng_at86rf2xx_set_txpower(ng_at86rf2xx_t *dev, int16_t txpower);
+
+/**
+ * @brief   Enable or disable driver specific options
+ *
+ * @param[in] dev           device to set/clear option flag for
+ * @param[in] option        option to enable/disable
+ * @param[in] state         true for enable, false for disable
+ */
+void ng_at86rf2xx_set_option(ng_at86rf2xx_t *dev, uint16_t option, bool state);
+
+/**
+ * @brief   Get the given devices current internal state
+ *
+ * @param[in] dev           device to get state of
+ * @return                  the current state of the given device
+ */
+uint8_t ng_at86rf2xx_get_state(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Set the state of the given device (trigger a state change)
+ *
+ * @param[in] dev           device to change state of
+ * @param[in] state         the targeted new state
+ */
+void ng_at86rf2xx_set_state(ng_at86rf2xx_t *dev, uint8_t state);
+
+/**
+ * @brief   Convenience function for simply sending data
+ *
+ * @note This function ignores the PRELOADING option
+ *
+ * @param[in] dev           device to use for sending
+ * @param[in] data          data to send (must include IEEE802.15.4 header)
+ * @param[in] len           length of @p data
+ *
+ * @return                  number of bytes that were actually send
+ * @return                  0 on error
+ */
+size_t ng_at86rf2xx_send(ng_at86rf2xx_t *dev, uint8_t *data, size_t len);
+
+/**
+ * @brief   Prepare for sending of data
+ *
+ * This function puts the given device into the TX state, so no receiving of
+ * data is possible after it was called.
+ *
+ * @param[in] dev            device to prepare for sending
+ */
+void ng_at86rf2xx_tx_prepare(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Load chunks of data into the transmit buffer of the given device
+ *
+ * @param[in] dev           device to write data to
+ * @param[in] data          buffer containing the data to load
+ * @param[in] len           number of bytes in @p buffer
+ * @param[in] offset        offset used when writing data to internal buffer
+ *
+ * @return                  offset + number of bytes written
+ */
+size_t ng_at86rf2xx_tx_load(ng_at86rf2xx_t *dev, uint8_t *data, size_t len,
+                            size_t offset);
+
+/**
+ * @brief   Trigger sending of data previously loaded into transmit buffer
+ *
+ * @param[in] dev           device to trigger
+ */
+void ng_at86rf2xx_tx_exec(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Read the length of a received packet
+ *
+ * @param dev               device to read from
+ *
+ * @return                  overall length of a received packet in byte
+ */
+size_t ng_at86rf2xx_rx_len(ng_at86rf2xx_t *dev);
+
+/**
+ * @brief   Read a chunk of data from the receive buffer of the given device
+ *
+ * @param[in]  dev          device to read from
+ * @param[out] data         buffer to write data to
+ * @param[in]  len          number of bytes to read from device
+ * @param[in]  offset       offset in the receive buffer
+ */
+void ng_at86rf2xx_rx_read(ng_at86rf2xx_t *dev, uint8_t *data, size_t len,
+                          size_t offset);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* NG_AT86RF2XX_H_ */
+/** @} */

drivers/ng_at86rf2xx/Makefile

@@ -0,0 +1 @@
+include $(RIOTBASE)/Makefile.base