Loading...
Searching...
No Matches
cc2420.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2015 Freie Universität Berlin
3 *
4 * This file is subject to the terms and conditions of the GNU Lesser General
5 * Public License v2.1. See the file LICENSE in the top level directory for more
6 * details.
7 */
8
21#ifndef CC2420_H
22#define CC2420_H
23
24#include <stdint.h>
25
26#include "periph/spi.h"
27#include "periph/gpio.h"
28
29#include "net/netdev.h"
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
39#define CC2420_PKT_MAXLEN (IEEE802154_FRAME_LEN_MAX)
40
45#define CC2420_CHAN_MIN (IEEE802154_CHANNEL_MIN)
46#define CC2420_CHAN_MAX (IEEE802154_CHANNEL_MAX)
47#define CC2420_CHAN_DEFAULT (CONFIG_IEEE802154_DEFAULT_CHANNEL)
54#define CC2420_TXPOWER_MIN (-25)
55#define CC2420_TXPOWER_MAX (0)
56#define CC2420_TXPOWER_DEFAULT (CONFIG_IEEE802154_DEFAULT_TXPOWER)
62#define CC2420_RSSI_OFFSET (-45)
63
67enum {
68 CC2420_RET_CHAN_OK = 2,
69};
70
74typedef struct cc2420_params {
75 spi_t spi;
77 gpio_t pin_cs;
78 gpio_t pin_fifo;
79 gpio_t pin_fifop;
80 gpio_t pin_cca;
81 gpio_t pin_sfd;
82 gpio_t pin_vrefen;
83 gpio_t pin_reset;
85
89typedef struct {
90 /* netdev fields */
92 /* device specific fields */
94 /* device state fields */
95 uint8_t state;
96 uint16_t options;
97} cc2420_t;
98
110void cc2420_setup(cc2420_t *dev, const cc2420_params_t *params, uint8_t index);
111
121
130
140
147void cc2420_get_addr_short(cc2420_t *dev, uint8_t *addr);
148
155void cc2420_set_addr_short(cc2420_t *dev, const uint8_t *addr);
156
165void cc2420_get_addr_long(cc2420_t *dev, uint8_t *addr_long);
166
173void cc2420_set_addr_long(cc2420_t *dev, const uint8_t *addr_long);
174
183
190void cc2420_set_pan(cc2420_t *dev, uint16_t pan);
191
200
207int cc2420_set_chan(cc2420_t *dev, uint16_t chan);
208
217
229void cc2420_set_txpower(cc2420_t *dev, int16_t txpower);
230
238int cc2420_set_option(cc2420_t *dev, uint16_t option, bool state);
239
247
256
268size_t cc2420_send(cc2420_t *dev, const iolist_t *iolist);
269
280
287
299int cc2420_rx(cc2420_t *dev, uint8_t *buf, size_t max_len, void *info);
300
301#ifdef __cplusplus
302}
303#endif
304
305#endif /* CC2420_H */
spi_clk_t
Definition periph_cpu.h:352
Definitions for netdev common IEEE 802.15.4 code.
Definitions low-level network driver interface.
Low-level GPIO peripheral driver interface definitions.
void cc2420_get_addr_short(cc2420_t *dev, uint8_t *addr)
Get the short address of the given device.
void cc2420_set_pan(cc2420_t *dev, uint16_t pan)
Set the PAN ID of the given device.
int16_t cc2420_get_txpower(cc2420_t *dev)
Get the configured transmission power of the given device [in dBm].
void cc2420_set_txpower(cc2420_t *dev, int16_t txpower)
Set the transmission power of the given device [in dBm].
int cc2420_rx(cc2420_t *dev, uint8_t *buf, size_t max_len, void *info)
Read a chunk of data from the receive buffer of the given device.
int cc2420_set_option(cc2420_t *dev, uint16_t option, bool state)
Enable or disable driver specific options.
void cc2420_set_addr_long(cc2420_t *dev, const uint8_t *addr_long)
Set the long address of the given device.
void cc2420_setup(cc2420_t *dev, const cc2420_params_t *params, uint8_t index)
Setup the device descriptor for the given device.
uint16_t cc2420_get_chan(cc2420_t *dev)
Get the configured channel of the given device.
struct cc2420_params cc2420_params_t
Struct holding all parameters needed for device initialization.
bool cc2420_cca(cc2420_t *dev)
Trigger a clear channel assessment.
size_t cc2420_tx_prepare(cc2420_t *dev, const iolist_t *iolist)
Prepare for sending of data.
int cc2420_init(cc2420_t *dev)
Initialize a given CC2420 device.
void cc2420_tx_exec(cc2420_t *dev)
Trigger sending of data previously loaded into transmit buffer.
netopt_state_t cc2420_get_state(cc2420_t *dev)
Get the state of the given device.
void cc2420_get_addr_long(cc2420_t *dev, uint8_t *addr_long)
Get the configured long address of the given device.
uint16_t cc2420_get_pan(cc2420_t *dev)
Get the configured PAN ID of the given device.
void cc2420_set_addr_short(cc2420_t *dev, const uint8_t *addr)
Set the short address of the given device.
int cc2420_reset(cc2420_t *dev)
Trigger a hardware reset and configure radio with default values.
int cc2420_set_chan(cc2420_t *dev, uint16_t chan)
Set the channel of the given device.
int cc2420_set_state(cc2420_t *dev, netopt_state_t state)
Set the state of the given device (trigger a state change)
size_t cc2420_send(cc2420_t *dev, const iolist_t *iolist)
Convenience function for simply sending data.
netopt_state_t
Option parameter to be used with NETOPT_STATE to set or get the state of a network device or protocol...
Definition netopt.h:894
Low-level SPI peripheral driver interface definition.
Struct holding all parameters needed for device initialization.
Definition cc2420.h:74
gpio_t pin_cca
pin connected to CCA
Definition cc2420.h:80
gpio_t pin_reset
pin connected to the reset pin
Definition cc2420.h:83
spi_clk_t spi_clk
SPI speed to use.
Definition cc2420.h:76
gpio_t pin_fifo
pin connected to the FIFO interrupt pin
Definition cc2420.h:78
gpio_t pin_cs
pin connected to chip select
Definition cc2420.h:77
gpio_t pin_vrefen
pin connected to the Vref enable pin
Definition cc2420.h:82
gpio_t pin_fifop
pin connected to the FIFOP interrupt pin
Definition cc2420.h:79
spi_t spi
SPI bus the device is connected to.
Definition cc2420.h:75
gpio_t pin_sfd
pin connected to 'start of frame delimiter'
Definition cc2420.h:81
Device descriptor for CC2420 radio devices.
Definition cc2420.h:89
uint16_t options
state of used options
Definition cc2420.h:96
cc2420_params_t params
hardware interface configuration
Definition cc2420.h:93
uint8_t state
current state of the radio
Definition cc2420.h:95
netdev_ieee802154_t netdev
netdev parent struct
Definition cc2420.h:91
iolist structure definition
Definition iolist.h:39
Extended structure to hold IEEE 802.15.4 driver state.
Definition ieee802154.h:100