Loading...
Searching...
No Matches
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
208extern "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
231#ifdef MODULE_GNRC_SIXLOWPAN
232#define CC110X_DEFAULT_PROTOCOL (GNRC_NETTYPE_SIXLOWPAN)
233#else
234#define CC110X_DEFAULT_PROTOCOL (GNRC_NETTYPE_UNDEF)
235#endif
236
246#ifndef CONFIG_CC110X_DEFAULT_CHANNEL
247#define CONFIG_CC110X_DEFAULT_CHANNEL (0U)
248#endif
295
310
324typedef struct {
325 uint8_t data[8];
327
351typedef struct {
352 uint8_t base_freq[3];
364 uint8_t fsctrl1;
380 uint8_t mdmcfg4;
396 uint8_t mdmcfg3;
419 uint8_t deviatn;
421
447typedef struct {
448 uint8_t map[CC110X_MAX_CHANNELS];
450
468
472typedef struct {
478 char fscal2;
479 char fscal3;
481
490typedef struct __attribute__((packed)) {
491 uint8_t len;
506 uint8_t pos;
508
512typedef struct {
514 uint8_t addr;
515 /* Keep above in sync with cc1xx_t members, as they must overlap! */
518 uint8_t channel;
519 /* Struct packing: addr, state, tx_power and channel add up to 32 bit */
539 uint8_t rssi_offset;
540} cc110x_t;
541
556int cc110x_setup(cc110x_t *dev, const cc110x_params_t *params, uint8_t index);
557
583 const cc110x_chanmap_t *chanmap, uint8_t channel);
584
601
620int cc110x_set_channel(cc110x_t *dev, uint8_t channel);
621
635
643
650
651#ifdef __cplusplus
652}
653#endif
654
655#endif /* CC110X_H */
Low-level ADC peripheral driver interface definitions.
spi_clk_t
Definition periph_cpu.h:352
CC110x/CC1200 adaption for Network interface API.
Definitions low-level network driver interface.
Low-level GPIO peripheral driver interface definitions.
cc110x_state_t
The state of the CC1100/CC1101 transceiver.
Definition cc110x.h:258
int cc110x_set_channel(cc110x_t *dev, uint8_t channel)
Hops to the specified channel.
int cc110x_full_calibration(cc110x_t *dev)
Perform a calibration of the frequency generator for each supported channel.
cc110x_tx_power_t
Enumeration over the possible TX power settings the driver offers.
Definition cc110x.h:299
#define CC110X_MAX_CHANNELS
Maximum number of channels supported by the driver.
Definition cc110x.h:226
#define CC110X_MAX_FRAME_SIZE
Length of a layer 2 frame.
Definition cc110x.h:216
int cc110x_set_tx_power(cc110x_t *dev, cc110x_tx_power_t power)
Set the TX power to the specified value.
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.
void cc110x_sleep(cc110x_t *dev)
Sets the transceiver into SLEEP mode.
int cc110x_setup(cc110x_t *dev, const cc110x_params_t *params, uint8_t index)
Setup the CC1100/CC1101 driver, but perform no initialization.
int cc110x_wakeup(cc110x_t *dev)
Wakes the transceiver from SLEEP mode and enters RX mode.
@ CC110X_STATE_CALIBRATE
Device is calibrating.
Definition cc110x.h:290
@ CC110X_STATE_RECEIVING
Receiving a frame just now.
Definition cc110x.h:281
@ CC110X_STATE_OFF
Devices is powered down.
Definition cc110x.h:274
@ CC110X_STATE_RXFIFO_OVERFLOW
RX FIFO overflown.
Definition cc110x.h:292
@ CC110X_STATE_FRAME_READY
Frame received, waiting for upper layer to retrieve it.
Definition cc110x.h:265
@ CC110X_STATE_FSTXON
Fast TX ready.
Definition cc110x.h:289
@ CC110X_STATE_SETTLING
PLL is settling.
Definition cc110x.h:291
@ CC110X_STATE_TX_COMPLETING
Waiting for transceiver to complete outgoing transmission.
Definition cc110x.h:288
@ CC110X_STATE_RX_MODE
Listening for frames.
Definition cc110x.h:275
@ CC110X_STATE_TX_MODE
Transmit mode.
Definition cc110x.h:282
@ CC110X_STATE_IDLE
IDLE state.
Definition cc110x.h:259
@ CC110X_STATE_TXFIFO_UNDERFLOW
TX FIFO underflown.
Definition cc110x.h:293
@ CC110X_TX_POWER_MINUS_30_DBM
-30 dBm
Definition cc110x.h:300
@ CC110X_TX_POWER_MINUS_10_DBM
-10 dBm
Definition cc110x.h:303
@ CC110X_TX_POWER_MINUS_15_DBM
-15 dBm
Definition cc110x.h:302
@ CC110X_TX_POWER_PLUS_5_DBM
5 dBm
Definition cc110x.h:305
@ CC110X_TX_POWER_0_DBM
0 dBm
Definition cc110x.h:304
@ CC110X_TX_POWER_NUMOF
Number of TX power options.
Definition cc110x.h:308
@ CC110X_TX_POWER_MINUS_20_DBM
-20 dBm
Definition cc110x.h:301
@ CC110X_TX_POWER_PLUS_7_DBM
7 dBm
Definition cc110x.h:306
@ CC110X_TX_POWER_PLUS_10_DBM
10 dBm
Definition cc110x.h:307
gpio_t spi_cs_t
Chip select pin type overlaps with gpio_t so it can be casted to this.
Definition spi.h:135
Mutex for thread synchronization.
Protocol type definitions.
Low-level SPI peripheral driver interface definition.
Structure to hold mapping between virtual and physical channel numbers.
Definition cc110x.h:447
Configuration of the transceiver to use.
Definition cc110x.h:351
uint8_t mdmcfg4
MDMCFG4 configuration register value that affects channel filter bandwidth and the data rate.
Definition cc110x.h:380
uint8_t deviatn
DEVIANT configuration register that affects the amount by which the radio frequency is shifted in FSK...
Definition cc110x.h:419
uint8_t fsctrl1
FSCTRL1 configuration register value that affects the intermediate frequency of the transceiver to us...
Definition cc110x.h:364
uint8_t mdmcfg3
MDMCFG3 configuration register value that affects the data rate.
Definition cc110x.h:396
Buffer to temporary store incoming/outgoing packet.
Definition cc110x.h:490
uint8_t pos
Index of the next cc110x_framebuf_t::data element to transfer.
Definition cc110x.h:506
uint8_t len
Length of the frame in bytes.
Definition cc110x.h:491
Structure holding the calibration data of the frequency synthesizer.
Definition cc110x.h:472
char fscal2
VCO current calibration, independent of channel.
Definition cc110x.h:478
char fscal3
charge pump current calibration, independent of channel
Definition cc110x.h:479
Structure holding all parameter for driver initialization.
Definition cc110x.h:454
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:460
const cc110x_chanmap_t * channels
Pointer to the default channel map.
Definition cc110x.h:461
spi_t spi
SPI bus connected to the device.
Definition cc110x.h:462
const cc110x_patable_t * patable
Pointer to the PATABLE to use.
Definition cc110x.h:455
gpio_t gdo2
GPIO pin connected to GDO2.
Definition cc110x.h:466
spi_clk_t spi_clk
SPI clock to use (max 6.5 MHz)
Definition cc110x.h:463
spi_cs_t cs
GPIO pin connected to chip select.
Definition cc110x.h:464
gpio_t gdo0
GPIO pin connected to GDO0.
Definition cc110x.h:465
Structure that holds the PATABLE, which allows to configure the 8 available output power levels using...
Definition cc110x.h:324
Device descriptor for CC1100/CC1101 transceivers.
Definition cc110x.h:512
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:538
cc110x_state_t state
State of the transceiver.
Definition cc110x.h:516
const cc110x_chanmap_t * channels
Pointer to the channel map to use.
Definition cc110x.h:520
netdev_t netdev
RIOT's interface to this driver.
Definition cc110x.h:513
cc1xxx_rx_info_t rx_info
RSSI and LQI of the last received frame.
Definition cc110x.h:526
cc110x_tx_power_t tx_power
TX power of the receiver.
Definition cc110x.h:517
uint8_t channel
Currently tuned (virtual) channel.
Definition cc110x.h:518
uint8_t addr
Layer 2 address of this device.
Definition cc110x.h:514
cc110x_fs_calibration_t fscal
Frequency synthesizer calibration data.
Definition cc110x.h:530
cc110x_framebuf_t buf
Temporary frame buffer.
Definition cc110x.h:522
uint8_t rssi_offset
dBm to subtract from raw RSSI data
Definition cc110x.h:539
cc110x_params_t params
Configuration of the driver.
Definition cc110x.h:521
Mutex structure.
Definition mutex.h:146
Received frame status information for most radios.
Definition netdev.h:279
Structure to hold driver state.
Definition netdev.h:362