1
0
mirror of git://projects.qi-hardware.com/ben-wpan.git synced 2024-11-22 23:55:54 +02:00
ben-wpan/fw/include/at86rf230.h
Werner Almesberger 7a534d2269 Enter TRX_OFF to enable DVDD regulator. Plus minor cleanup.
- tools/atspi-txrx/Makefile, tools/atspi-txrx/atspi-txrx.c: new utility
  that, for now, just turns on the DVDD regulator
- tools/atspi-id/Makefile: corrected path in title
- fw/include/at86rf230.h: changed TRX_STATE_* to TRX_CMD_*
2010-08-21 01:42:58 -03:00

289 lines
7.0 KiB
C

/*
* atspi/at86rf230.h - AT86RF230 protocol and register definitions
*
* Written 2008-2010 by Werner Almesberger
* Copyright 2008-2010 Werner Almesberger
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*/
#ifndef AT86RF230_H
#define AT86RF230_H
enum {
AT86RF230_REG_WRITE = 0xc0, /* 11... */
AT86RF230_REG_READ = 0x80, /* 10... */
AT86RF230_BUF_WRITE = 0x60, /* 011... */
AT86RF230_BUF_READ = 0x20, /* 001... */
AT86RF230_SRAM_WRITE = 0x40, /* 010... */
AT86RF230_SRAM_READ = 0x00 /* 000... */
};
#define MAX_PSDU 127 /* octets, see AT86RF230 manual section 8.1 */
#define SRAM_SIZE 128
/* --- Registers ----------------------------------------------------------- */
enum {
REG_TRX_STATUS = 0x01,
REG_TRX_STATE = 0x02,
REG_TRX_CTRL_0 = 0x03,
REG_TR_PWR = 0x05,
REG_PHY_RSSI = 0x06,
REG_PHY_ED_LEVEL = 0x07,
REG_PHY_CC_CCA = 0x08,
REG_CCA_THRES = 0x09,
REG_IRQ_MASK = 0x0e,
REG_IRQ_STATUS = 0x0f,
REG_VREG_CTRL = 0x10,
REG_BATMON = 0x10,
REG_XOSC_CTRL = 0x12,
REG_PLL_CF = 0x1a,
REL_PLL_DCU = 0x1b,
REG_PART_NUM = 0x1c,
REG_VERSION_NUM = 0x1d,
REG_MAN_ID_0 = 0x1e,
REG_MAN_ID_1 = 0x1f,
REG_SHORT_ADDR_0 = 0x20,
REG_SHORT_ADDR_1 = 0x21,
REG_PAN_ID_0 = 0x22,
REG_PAN_ID_1 = 0x23,
REG_IEEE_ADDR_0 = 0x24,
REG_IEEE_ADDR_1 = 0x25,
REG_IEEE_ADDR_2 = 0x26,
REG_IEEE_ADDR_3 = 0x27,
REG_IEEE_ADDR_4 = 0x28,
REG_IEEE_ADDR_5 = 0x29,
REG_IEEE_ADDR_6 = 0x2a,
REG_IEEE_ADDR_7 = 0x2b,
REG_XAH_CTRL = 0x2c,
REG_CSMA_SEED_0 = 0x2d,
REG_CSMA_SEED_1 = 0x2e,
};
/* --- TRX_STATUS [7] ------------------------------------------------------ */
#define CCA_DONE (1 << 7)
/* --- TRX_STATUS [6] ------------------------------------------------------ */
#define CCA_STATUS (1 << 6)
/* --- TRX_STATUS [4:0] ---------------------------------------------------- */
#define TRX_STATUS_SHIFT 0
#define TRX_STATUS_MASK 0x0f
enum {
TRX_STATUS_P_ON = 0x00, /* reset default */
TRX_STATUS_BUSY_RX = 0x01,
TRX_STATUS_BUSY_TX = 0x02,
TRX_STATUS_RX_ON = 0x06,
TRX_STATUS_TRX_OFF = 0x08,
TRX_STATUS_PLL_ON = 0x09,
TRX_STATUS_SLEEP = 0x0f,
TRX_STATUS_BUSY_RX_AACK = 0x11,
TRX_STATUS_BUSY_TX_ARET = 0x12,
TRX_STATUS_RX_AACK_ON = 0x16,
TRX_STATUS_TX_ARET_ON = 0x19,
TRX_STATUS_RX_ON_NOCLK = 0x1c,
TRX_STATUS_RX_AACK_ON_NOCLK = 0x1d,
TRX_STATUS_BUSY_RX_AACK_NOCLK = 0x1e,
TRX_STATUS_TRANSITION = 0x1f
};
/* --- TRX_STATE [7:5] ----------------------------------------------------- */
#define TRAC_STATUS_SHIFT 5
#define TRAC_STATUS_MASK 7
enum {
TRAC_STATUS_SUCCESS = 0, /* reset default */
TRAC_STATUS_SUCCESS_DATA_PENDING = 1,
TRAC_STATUS_CHANNEL_ACCESS_FAILURE = 3,
TRAC_STATUS_NO_ACK = 5,
TRAC_STATUS_INVALID = 7
};
/* --- TRX_CMD [4:0] ----------------------------------------------------- */
#define TRX_CMD_SHIFT 0
#define TRX_CMD_MASK 7
enum {
TRX_CMD_NOP = 0x00, /* reset default */
TRX_CMD_TX_START = 0x02,
TRX_CMD_FORCE_TRX_OFF = 0x03,
TRX_CMD_RX_ON = 0x06,
TRX_CMD_TRX_OFF = 0x08,
TRX_CMD_PLL_ON = 0x09,
TRX_CMD_RX_AACK_ON = 0x16,
TRX_CMD_TX_ARET_ON = 0x19,
};
/* --- TRX_CTRL_0 [7:6] ---------------------------------------------------- */
#define PAD_IO_SHIFT 6
#define PAD_IO_MASK 3
enum {
PAD_IO_2mA, /* reset default */
PAD_IO_4mA,
PAD_IO_6mA,
PAD_IO_8mA
};
/* --- TRX_CTRL_0 [5:4] ---------------------------------------------------- */
#define PAD_IO_CLKM_SHIFT 4
#define PAD_IO_CLKM_MASK 3
enum {
PAD_IO_CLKM_2mA,
PAD_IO_CLKM_4mA, /* reset default */
PAD_IO_CLKM_5mA,
PAD_IO_CLKM_8mA,
};
/* --- TRX_CTRL_0 [3] ------------------------------------------------------ */
#define CLKM_SHA_SEL (1 << 3)
/* --- TRX_CTRL_0 [2:0] ---------------------------------------------------- */
#define CLKM_CTRL_SHIFT 0
#define CLKM_CTRL_MASK 3
enum {
CLKM_CTRL_OFF = 0,
CLKM_CTRL_1MHz = 1, /* reset default */
CLKM_CTRL_2MHz = 2,
CLKM_CTRL_4MHz = 3,
CLKM_CTRL_8MHz = 4,
CLKM_CTRL_16MHz = 5
};
/* --- PHY_TX_PWR [7] ------------------------------------------------------ */
#define TX_AUTO_CRC_ON (1 << 7)
/* --- PHY_TX_PWR [3:0] ---------------------------------------------------- */
#define TX_PWR_SHIFT 0
#define TX_PWR_MASK 0x0f
/* --- PHY_RSSI [7] -------------------------------------------------------- */
#define RX_CRC_VALID (1 << 7)
/* --- PHY_RSSI [4:0] ------------------------------------------------------ */
#define RSSI_SHIFT 0
#define RSSI_MASK 0x1f
/* --- PHY_CC_CCA [7] ------------------------------------------------------ */
#define CCA_REQUEST (1 << 7)
/* --- PHY_CC_CCA [6:5] ---------------------------------------------------- */
#define CCA_MODE_SHIFT 5
#define CCA_MODE_MASK 3
/* --- PHY_CC_CCA [4:0] ---------------------------------------------------- */
#define CHANNEL_SHIFT 0
#define CHANNEL_MASK 0x1f
/* --- CCA_THRES [3:0] ----------------------------------------------------- */
#define CCA_ED_THRES_SHIFT 0
#define CCA_ED_THRES_MASK 0x0f
/* --- IRQ_MASK/IRQ_STATUS ------------------------------------------------- */
enum {
IRQ_PLL_LOCK = 1 << 0,
IRQ_PLL_UNLOCK = 1 << 1,
IRQ_RX_START = 1 << 2,
IRQ_TRX_END = 1 << 3,
IRQ_TRX_UR = 1 << 6,
IRQ_BAT_LOW = 1 << 7
};
/* --- VREG_CTRL [7, 6, 3, 2] ---------------------------------------------- */
#define AVREG_EXT (1 << 7)
#define AVDD_OK (1 << 6)
#define DVREG_EXT (1 << 3)
#define DVDD_OK (1 << 2)
/* --- BATMON [5, 4] ------------------------------------------------------- */
#define BATMON_OK (1 << 5)
#define BATMON_HR (1 << 4)
/* --- BATMON [3:0] -------------------------------------------------------- */
#define NATMON_VTH_SHIFT 0
#define NATMON_VTH_MASK 0x0f
/* --- XOSC_CTRL [7:4] ----------------------------------------------------- */
#define XTAL_MODE_SHIFT 4
#define XTAL_MODE_MASK 0x0f
enum {
XTAL_MODE_OFF = 0x0,
XTAL_MODE_EXT = 0x4,
XTAL_MODE_INT = 0xf /* reset default */
};
/* --- XOSC_CTRL [3:1] ----------------------------------------------------- */
#define XTAL_TRIM_SHIFT 4
#define XTAL_TRIM_MASK 0x0f
/* --- XAH_CTRL [7:4] ------------------------------------------------------ */
#define MAX_FRAME_RETRIES_SHIFT 4
#define MAX_FRAME_RETRIES_MASK 0x0f
#define MAX_CSMA_RETRIES_SHIFT 1
#define MAX_CSMA_RETRIES_MASK 0x07
/* --- PLL_CF [7] ---------------------------------------------------------- */
#define PLL_CF_START (1 << 7)
/* --- PLL_DCU [8] --------------------------------------------------------- */
#define PLL_DCU_START (1 << 7)
/* --- CSMA_SEED_1 [7:6] --------------------------------------------------- */
#define MIN_BE_SHIFT 6
#define MIN_BE_MASK 3
/* --- CSMA_SEED_1 [5] ----------------------------------------------------- */
#define AACK_SET_PD (1 << 5)
/* --- CSMA_SEED_1 [3] ----------------------------------------------------- */
#define I_AM_COORD (1 << 3)
/* --- CSMA_SEED_1 [2:0] --------------------------------------------------- */
#define CSMA_SEED_1_SHIFT 0
#define CSMA_SEED_1_MASK 7
#endif /* !AT86RF230_H */