cc110x.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2013 INRIA
3  * 2014 Freie Universit├Ąt Berlin
4  * 2015 Kaspar Schleiser <kaspar@schleiser.de>
5  * 2018,2019 Otto-von-Guericke-Universit├Ąt Magdeburg
6  *
7  * This file is subject to the terms and conditions of the GNU Lesser General
8  * Public License v2.1. See the file LICENSE in the top level directory for more
9  * details.
10  */
11 
194 #ifndef CC110X_H
195 #define CC110X_H
196 
197 #include <stdint.h>
198 
199 #include "cc1xxx_common.h"
200 #include "mutex.h"
201 #include "net/gnrc/nettype.h"
202 #include "net/netdev.h"
203 #include "periph/adc.h"
204 #include "periph/gpio.h"
205 #include "periph/spi.h"
206 
207 #ifdef __cplusplus
208 extern "C" {
209 #endif
210 
216 #define CC110X_MAX_FRAME_SIZE 0xFF
217 
221 #define CC110X_MAX_PAYLOAD_SIZE (CC110X_MAX_FRAME_SIZE - CC1XXX_HEADER_SIZE)
222 
226 #define CC110X_MAX_CHANNELS 8
227 
232 #define CC110X_L2ADDR_AUTO 0x00
233 
237 #ifdef MODULE_GNRC_SIXLOWPAN
238 #define CC110X_DEFAULT_PROTOCOL (GNRC_NETTYPE_SIXLOWPAN)
239 #else
240 #define CC110X_DEFAULT_PROTOCOL (GNRC_NETTYPE_UNDEF)
241 #endif
242 
251 #ifndef CONFIG_CC110X_DEFAULT_CHANNEL
252 #define CONFIG_CC110X_DEFAULT_CHANNEL (0U)
253 #endif
254 
263 typedef enum {
264  CC110X_STATE_IDLE = 0b00000000,
279  CC110X_STATE_OFF = 0b00010000,
280  CC110X_STATE_RX_MODE = 0b00000001,
287  CC110X_STATE_TX_MODE = 0b00000010,
294  CC110X_STATE_FSTXON = 0b00000011,
295  CC110X_STATE_CALIBRATE = 0b00000100,
296  CC110X_STATE_SETTLING = 0b00000101,
300 
304 typedef enum {
315 
329 typedef struct {
330  uint8_t data[8];
332 
333 
357 typedef struct {
358  uint8_t base_freq[3];
370  uint8_t fsctrl1;
386  uint8_t mdmcfg4;
402  uint8_t mdmcfg3;
425  uint8_t deviatn;
427 
453 typedef struct {
454  uint8_t map[CC110X_MAX_CHANNELS];
456 
460 typedef struct {
471  gpio_t gdo0;
472  gpio_t gdo2;
477  uint8_t l2addr;
479 
483 typedef struct {
488  char fscal1[CC110X_MAX_CHANNELS];
489  char fscal2;
490  char fscal3;
492 
501 typedef struct __attribute__((packed)) {
502  uint8_t len;
506  uint8_t data[CC110X_MAX_FRAME_SIZE];
517  uint8_t pos;
519 
523 typedef struct {
525  uint8_t addr;
526  /* Keep above in sync with cc1xx_t members, as they must overlap! */
527  cc110x_state_t state;
528  cc110x_tx_power_t tx_power;
529  uint8_t channel;
530  /* Struct packing: addr, state, tx_power and channel add up to 32 bit */
550  uint8_t rssi_offset;
551 } cc110x_t;
552 
565 int cc110x_setup(cc110x_t *dev, const cc110x_params_t *params);
566 
591 int cc110x_apply_config(cc110x_t *dev, const cc110x_config_t *conf,
592  const cc110x_chanmap_t *chanmap, uint8_t channel);
593 
610 
629 int cc110x_set_channel(cc110x_t *dev, uint8_t channel);
630 
643 int cc110x_set_tx_power(cc110x_t *dev, cc110x_tx_power_t power);
644 
645 #ifdef __cplusplus
646 }
647 #endif
648 
649 #endif /* CC110X_H */
650 
Transmit mode.
Definition: cc110x.h:287
gpio_t gdo2
GPIO pin connected to GDO2.
Definition: cc110x.h:472
int cc110x_set_tx_power(cc110x_t *dev, cc110x_tx_power_t power)
Set the TX power to the specified value.
Listening for frames.
Definition: cc110x.h:280
cc110x_fs_calibration_t fscal
Frequency synthesizer calibration data.
Definition: cc110x.h:541
Fast TX ready.
Definition: cc110x.h:294
Waiting for transceiver to complete outgoing transmission.
Definition: cc110x.h:293
CC110x/CC1200 adaption for Network interface API.
Low-level GPIO peripheral driver interface definitions.
int cc110x_set_channel(cc110x_t *dev, uint8_t channel)
Hops to the specified channel.
char fscal3
charge pump current calibration, independent of channel
Definition: cc110x.h:490
cc110x_params_t params
Configuration of the driver.
Definition: cc110x.h:532
spi_cs_t cs
GPIO pin connected to chip select.
Definition: cc110x.h:470
uint8_t channel
Currently tuned (virtual) channel.
Definition: cc110x.h:529
uint8_t deviatn
DEVIANT configuration register that affects the amount by which the radio frequency is shifted in FSK...
Definition: cc110x.h:425
Definitions low-level network driver interface.
uint8_t rssi_offset
dBm to subtract from raw RSSI data
Definition: cc110x.h:550
PLL is settling.
Definition: cc110x.h:296
uint8_t l2addr
Layer-2 address to use or CC110X_L2ADDR_AUTO to derive it from the CPU ID.
Definition: cc110x.h:477
const cc110x_chanmap_t * channels
Pointer to the channel map to use.
Definition: cc110x.h:531
uint8_t addr
Layer 2 address of this device.
Definition: cc110x.h:525
Low-level ADC peripheral driver interface definitions.
Received packet status information for most radios.
Definition: netdev.h:257
RX FIFO overflown.
Definition: cc110x.h:297
Low-level SPI peripheral driver interface definition.
Device is calibrating.
Definition: cc110x.h:295
gpio_t spi_cs_t
Chip select pin type overlaps with gpio_t so it can be casted to this.
Definition: spi.h:126
#define CC110X_MAX_CHANNELS
Maximum number of channels supported by the driver.
Definition: cc110x.h:226
uint8_t mdmcfg3
MDMCFG3 configuration register value that affects the data rate.
Definition: cc110x.h:402
Frame received, waiting for upper layer to retrieve it.
Definition: cc110x.h:270
Structure holding all parameter for driver initialization.
Definition: cc110x.h:460
int cc110x_setup(cc110x_t *dev, const cc110x_params_t *params)
Setup the CC1100/CC1101 driver, but perform no initialization.
uint8_t len
Length of the frame in bytes.
Definition: cc110x.h:502
TX FIFO underflown.
Definition: cc110x.h:298
spi_clk_t
Available SPI clock speeds.
Definition: spi.h:173
netdev_t netdev
RIOT&#39;s interface to this driver.
Definition: cc110x.h:524
cc110x_tx_power_t tx_power
TX power of the receiver.
Definition: cc110x.h:528
Structure to hold driver state.
Definition: netdev.h:283
uint8_t pos
Index of the next cc110x_framebuf_t::data element to transfer.
Definition: cc110x.h:517
Device descriptor for CC1100/CC1101 transceivers.
Definition: cc110x.h:523
uint8_t mdmcfg4
MDMCFG4 configuration register value that affects channel filter bandwidth and the data rate...
Definition: cc110x.h:386
spi_clk_t spi_clk
SPI clock to use (max 6.5 MHz)
Definition: cc110x.h:469
cc110x_state_t state
State of the transceiver.
Definition: cc110x.h:527
Mutex for thread synchronization.
const cc110x_chanmap_t * channels
Pointer to the default channel map.
Definition: cc110x.h:467
cc110x_tx_power_t
Enumeration over the possible TX power settings the driver offers.
Definition: cc110x.h:304
Number of TX power options.
Definition: cc110x.h:313
spi_t spi
SPI bus connected to the device.
Definition: cc110x.h:468
cc1xxx_rx_info_t rx_info
RSSI and LQI of the last received frame.
Definition: cc110x.h:537
const cc110x_config_t * config
Pointer to the configuration of the base frequency, data rate and channel bandwidth; or NULL to keep ...
Definition: cc110x.h:466
char fscal2
VCO current calibration, independent of channel.
Definition: cc110x.h:489
uint8_t fsctrl1
FSCTRL1 configuration register value that affects the intermediate frequency of the transceiver to us...
Definition: cc110x.h:370
Structure to hold mapping between virtual and physical channel numbers.
Definition: cc110x.h:453
Buffer to temporary store incoming/outgoing packet.
Definition: cc110x.h:501
#define CC110X_MAX_FRAME_SIZE
Length of a layer 2 frame.
Definition: cc110x.h:216
int cc110x_apply_config(cc110x_t *dev, const cc110x_config_t *conf, const cc110x_chanmap_t *chanmap, uint8_t channel)
Apply the given configuration and the given channel map and performs a recalibration.
IDLE state.
Definition: cc110x.h:264
Mutex structure.
Definition: mutex.h:37
mutex_t isr_signal
Use mutex to block during TX and unblock from ISR when ISR needs to be handled from thread-context...
Definition: cc110x.h:549
const cc110x_patable_t * patable
Pointer to the PATABLE to use.
Definition: cc110x.h:461
int cc110x_full_calibration(cc110x_t *dev)
Perform a calibration of the frequency generator for each supported channel.
Frame received, waiting for upper layer to retrieve it.
Definition: cc110x.h:279
Protocol type definitions.
cc110x_framebuf_t buf
Temporary frame buffer.
Definition: cc110x.h:533
gpio_t gdo0
GPIO pin connected to GDO0.
Definition: cc110x.h:471
cc110x_state_t
The state of the CC1100/CC1101 transceiver.
Definition: cc110x.h:263
unsigned int spi_t
Default type for SPI devices.
Definition: spi.h:118
Configuration of the transceiver to use.
Definition: cc110x.h:357
Structure holding the calibration data of the frequency synthesizer.
Definition: cc110x.h:483
Structure that holds the PATABLE, which allows to configure the 8 available output power levels using...
Definition: cc110x.h:329
Receiving a frame just now.
Definition: cc110x.h:286