at86rf230b.h

00001 /* THIS FILE IS GENERATED by ds2reg.py FROM INPUT Templates/at86rf230b.txt */
00002 
00003 /* Copyright (c) 2008 Axel Wachtler
00004    All rights reserved.
00005 
00006    Redistribution and use in source and binary forms, with or without
00007    modification, are permitted provided that the following conditions
00008    are met:
00009 
00010    * Redistributions of source code must retain the above copyright
00011      notice, this list of conditions and the following disclaimer.
00012    * Redistributions in binary form must reproduce the above copyright
00013      notice, this list of conditions and the following disclaimer in the
00014      documentation and/or other materials provided with the distribution.
00015    * Neither the name of the authors nor the names of its contributors
00016      may be used to endorse or promote products derived from this software
00017      without specific prior written permission.
00018 
00019    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00020    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00021    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00022    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00023    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00024    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00025    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00026    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00027    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00028    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00029    POSSIBILITY OF SUCH DAMAGE. */
00030 
00031 /* $Id$ */
00032 /**
00033  * @file
00034  * @brief AT86RF230 Rev.B 2.4GHz IEEE 802.15.4-Transceiver.
00035  */
00036 #ifndef AT86RF230B_H
00037 #define AT86RF230B_H (1)
00038 #include <stdint.h>
00039 #define _BV(bit) (1 << (bit))
00040 
00041 /* === Includes ============================================================== */
00042 
00043 /* === Externals ============================================================= */
00044 
00045 /* === Types ================================================================= */
00046 
00047 typedef uint8_t trx_ramaddr_t;
00048 typedef uint8_t trx_regval_t;
00049 typedef uint8_t trx_regaddr_t;
00050 
00051 /* === Macros ================================================================ */
00052 /** Offset for register TRX_STATUS */
00053 #define RG_TRX_STATUS (0x1)
00054   /** Access parameters for sub-register CCA_DONE in register TRX_STATUS */
00055   #define SR_CCA_DONE 0x1,0x80,7
00056   /** Access parameters for sub-register CCA_STATUS in register TRX_STATUS */
00057   #define SR_CCA_STATUS 0x1,0x40,6
00058   /** Access parameters for sub-register TRX_STATUS in register TRX_STATUS */
00059   #define SR_TRX_STATUS 0x1,0x1f,0
00060     #define P_ON (0)
00061     #define BUSY_RX (1)
00062     #define BUSY_TX (2)
00063     #define RX_ON (6)
00064     #define TRX_OFF (8)
00065     #define PLL_ON (9)
00066     #define TRX_SLEEP (15)
00067     #define BUSY_RX_AACK (17)
00068     #define BUSY_TX_ARET (18)
00069     #define RX_AACK_ON (22)
00070     #define TX_ARET_ON (25)
00071     #define RX_ON_NOCLK (28)
00072     #define RX_AACK_ON_NOCLK (29)
00073     #define BUSY_RX_AACK_NOCLK (30)
00074 /** Offset for register TRX_STATE */
00075 #define RG_TRX_STATE (0x2)
00076   /** Access parameters for sub-register TRAC_STATUS in register TRX_STATE */
00077   #define SR_TRAC_STATUS 0x2,0xe0,5
00078     #define TRAC_SUCCESS (0)
00079     #define TRAC_SUCCESS_DATA_PENDING (1)
00080     #define TRAC_CHANNEL_ACCESS_FAILURE (3)
00081     #define TRAC_NO_ACK (5)
00082     #define TRAC_INVALID (7)
00083   /** Access parameters for sub-register TRX_CMD in register TRX_STATE */
00084   #define SR_TRX_CMD 0x2,0x1f,0
00085     #define CMD_NOP (0)
00086     #define CMD_TX_START (2)
00087     #define CMD_FORCE_TRX_OFF (3)
00088     #define CMD_RX_ON (6)
00089     #define CMD_TRX_OFF (8)
00090     #define CMD_PLL_ON (9)
00091     #define CMD_RX_AACK_ON (22)
00092     #define CMD_TX_ARET_ON (25)
00093 /** Offset for register TRX_CTRL_0 */
00094 #define RG_TRX_CTRL_0 (0x3)
00095   /** Access parameters for sub-register PAD_IO in register TRX_CTRL_0 */
00096   #define SR_PAD_IO 0x3,0xc0,6
00097   /** Access parameters for sub-register PAD_IO_CLKM in register TRX_CTRL_0 */
00098   #define SR_PAD_IO_CLKM 0x3,0x30,4
00099     #define CLKM_2mA (0)
00100     #define CLKM_4mA (1)
00101     #define CLKM_6mA (2)
00102     #define CLKM_8mA (3)
00103   /** Access parameters for sub-register CLKM_SHA_SEL in register TRX_CTRL_0 */
00104   #define SR_CLKM_SHA_SEL 0x3,0x8,3
00105   /** Access parameters for sub-register CLKM_CTRL in register TRX_CTRL_0 */
00106   #define SR_CLKM_CTRL 0x3,0x7,0
00107     #define CLKM_no_clock (0)
00108     #define CLKM_1MHz (1)
00109     #define CLKM_2MHz (2)
00110     #define CLKM_4MHz (3)
00111     #define CLKM_8MHz (4)
00112     #define CLKM_16MHz (5)
00113 /** Offset for register PHY_TX_PWR */
00114 #define RG_PHY_TX_PWR (0x5)
00115   /** Access parameters for sub-register TX_AUTO_CRC_ON in register PHY_TX_PWR */
00116   #define SR_TX_AUTO_CRC_ON 0x5,0x80,7
00117   /** Access parameters for sub-register TX_PWR in register PHY_TX_PWR */
00118   #define SR_TX_PWR 0x5,0xf,0
00119 /** Offset for register PHY_RSSI */
00120 #define RG_PHY_RSSI (0x6)
00121   /** Access parameters for sub-register RX_CRC_VALID in register PHY_RSSI */
00122   #define SR_RX_CRC_VALID 0x6,0x80,7
00123   /** Access parameters for sub-register RSSI in register PHY_RSSI */
00124   #define SR_RSSI 0x6,0x1f,0
00125 /** Offset for register PHY_ED_LEVEL */
00126 #define RG_PHY_ED_LEVEL (0x7)
00127   /** Access parameters for sub-register ED_LEVEL in register PHY_ED_LEVEL */
00128   #define SR_ED_LEVEL 0x7,0xff,0
00129 /** Offset for register PHY_CC_CCA */
00130 #define RG_PHY_CC_CCA (0x8)
00131   /** Access parameters for sub-register CCA_REQUEST in register PHY_CC_CCA */
00132   #define SR_CCA_REQUEST 0x8,0x80,7
00133   /** Access parameters for sub-register CCA_MODE in register PHY_CC_CCA */
00134   #define SR_CCA_MODE 0x8,0x60,5
00135   /** Access parameters for sub-register CHANNEL in register PHY_CC_CCA */
00136   #define SR_CHANNEL 0x8,0x1f,0
00137 /** Offset for register CCA_THRES */
00138 #define RG_CCA_THRES (0x9)
00139   /** Access parameters for sub-register CCA_ED_THRES in register CCA_THRES */
00140   #define SR_CCA_ED_THRES 0x9,0xf,0
00141 /** Offset for register IRQ_MASK */
00142 #define RG_IRQ_MASK (0xe)
00143   /** Access parameters for sub-register MASK_BAT_LOW in register IRQ_MASK */
00144   #define SR_MASK_BAT_LOW 0xe,0x80,7
00145   /** Access parameters for sub-register MASK_TRX_UR in register IRQ_MASK */
00146   #define SR_MASK_TRX_UR 0xe,0x40,6
00147   /** Access parameters for sub-register MASK_TRX_END in register IRQ_MASK */
00148   #define SR_MASK_TRX_END 0xe,0x8,3
00149   /** Access parameters for sub-register MASK_TRX_START in register IRQ_MASK */
00150   #define SR_MASK_TRX_START 0xe,0x4,2
00151   /** Access parameters for sub-register MASK_PLL_LOCK in register IRQ_MASK */
00152   #define SR_MASK_PLL_LOCK 0xe,0x1,0
00153   /** Access parameters for sub-register MASK_PLL_UNLOCK in register IRQ_MASK */
00154   #define SR_MASK_PLL_UNLOCK 0xe,0x2,1
00155 /** Offset for register IRQ_STATUS */
00156 #define RG_IRQ_STATUS (0xf)
00157   /** Access parameters for sub-register BAT_LOW in register IRQ_STATUS */
00158   #define SR_BAT_LOW 0xf,0x80,7
00159   /** Access parameters for sub-register TRX_UR in register IRQ_STATUS */
00160   #define SR_TRX_UR 0xf,0x40,6
00161   /** Access parameters for sub-register RX_END in register IRQ_STATUS */
00162   #define SR_RX_END 0xf,0x8,3
00163   /** Access parameters for sub-register RX_START in register IRQ_STATUS */
00164   #define SR_RX_START 0xf,0x4,2
00165   /** Access parameters for sub-register PLL_LOCK in register IRQ_STATUS */
00166   #define SR_PLL_LOCK 0xf,0x1,0
00167   /** Access parameters for sub-register PLL_UNLOCK in register IRQ_STATUS */
00168   #define SR_PLL_UNLOCK 0xf,0x2,1
00169 /** Offset for register VREG_CTRL */
00170 #define RG_VREG_CTRL (0x10)
00171   /** Access parameters for sub-register AVREG_EXT in register VREG_CTRL */
00172   #define SR_AVREG_EXT 0x10,0x80,7
00173   /** Access parameters for sub-register AVDD_OK in register VREG_CTRL */
00174   #define SR_AVDD_OK 0x10,0x40,6
00175   /** Access parameters for sub-register DVREG_EXT in register VREG_CTRL */
00176   #define SR_DVREG_EXT 0x10,0x8,3
00177   /** Access parameters for sub-register DVDD_OK in register VREG_CTRL */
00178   #define SR_DVDD_OK 0x10,0x4,2
00179 /** Offset for register BATMON */
00180 #define RG_BATMON (0x11)
00181   /** Access parameters for sub-register BATMON_OK in register BATMON */
00182   #define SR_BATMON_OK 0x11,0x20,5
00183   /** Access parameters for sub-register BATMON_HR in register BATMON */
00184   #define SR_BATMON_HR 0x11,0x10,4
00185   /** Access parameters for sub-register BATMON_VTH in register BATMON */
00186   #define SR_BATMON_VTH 0x11,0xf,0
00187 /** Offset for register XOSC_CTRL */
00188 #define RG_XOSC_CTRL (0x12)
00189   /** Access parameters for sub-register XTAL_MODE in register XOSC_CTRL */
00190   #define SR_XTAL_MODE 0x12,0xf0,4
00191   /** Access parameters for sub-register XTAL_TRIM in register XOSC_CTRL */
00192   #define SR_XTAL_TRIM 0x12,0xf,0
00193 /** Offset for register PLL_CF */
00194 #define RG_PLL_CF (0x1a)
00195   /** Access parameters for sub-register PLL_CF_START in register PLL_CF */
00196   #define SR_PLL_CF_START 0x1a,0x80,7
00197 /** Offset for register PLL_DCU */
00198 #define RG_PLL_DCU (0x1b)
00199   /** Access parameters for sub-register PLL_DCU_START in register PLL_DCU */
00200   #define SR_PLL_DCU_START 0x1b,0x80,7
00201 /** Offset for register PART_NUM */
00202 #define RG_PART_NUM (0x1c)
00203   /** Access parameters for sub-register PART_NUM in register PART_NUM */
00204   #define SR_PART_NUM 0x1c,0xff,0
00205     #define RF230B_PART_NUM (2)
00206 /** Offset for register VERSION_NUM */
00207 #define RG_VERSION_NUM (0x1d)
00208   /** Access parameters for sub-register VERSION_NUM in register VERSION_NUM */
00209   #define SR_VERSION_NUM 0x1d,0xff,0
00210     #define RF230B_VERSION_NUM (2)
00211 /** Offset for register MAN_ID_0 */
00212 #define RG_MAN_ID_0 (0x1e)
00213   /** Access parameters for sub-register MAN_ID_0 in register MAN_ID_0 */
00214   #define SR_MAN_ID_0 0x1e,0xff,0
00215 /** Offset for register MAN_ID_1 */
00216 #define RG_MAN_ID_1 (0x1f)
00217   /** Access parameters for sub-register MAN_ID_1 in register MAN_ID_1 */
00218   #define SR_MAN_ID_1 0x1f,0xff,0
00219 /** Offset for register SHORT_ADDR_0 */
00220 #define RG_SHORT_ADDR_0 (0x20)
00221   /** Access parameters for sub-register SHORT_ADDR_0 in register SHORT_ADDR_0 */
00222   #define SR_SHORT_ADDR_0 0x20,0xff,0
00223 /** Offset for register SHORT_ADDR_1 */
00224 #define RG_SHORT_ADDR_1 (0x21)
00225   /** Access parameters for sub-register SHORT_ADDR_1 in register SHORT_ADDR_1 */
00226   #define SR_SHORT_ADDR_1 0x21,0xff,0
00227 /** Offset for register PAN_ID_0 */
00228 #define RG_PAN_ID_0 (0x22)
00229   /** Access parameters for sub-register PAN_ID_0 in register PAN_ID_0 */
00230   #define SR_PAN_ID_0 0x22,0xff,0
00231 /** Offset for register PAN_ID_1 */
00232 #define RG_PAN_ID_1 (0x23)
00233   /** Access parameters for sub-register PAN_ID_1 in register PAN_ID_1 */
00234   #define SR_PAN_ID_1 0x23,0xff,0
00235 /** Offset for register IEEE_ADDR_0 */
00236 #define RG_IEEE_ADDR_0 (0x24)
00237   /** Access parameters for sub-register IEEE_ADDR_0 in register IEEE_ADDR_0 */
00238   #define SR_IEEE_ADDR_0 0x24,0xff,0
00239 /** Offset for register IEEE_ADDR_1 */
00240 #define RG_IEEE_ADDR_1 (0x25)
00241   /** Access parameters for sub-register IEEE_ADDR_1 in register IEEE_ADDR_1 */
00242   #define SR_IEEE_ADDR_1 0x25,0xff,0
00243 /** Offset for register IEEE_ADDR_2 */
00244 #define RG_IEEE_ADDR_2 (0x26)
00245   /** Access parameters for sub-register IEEE_ADDR_2 in register IEEE_ADDR_2 */
00246   #define SR_IEEE_ADDR_2 0x26,0xff,0
00247 /** Offset for register IEEE_ADDR_3 */
00248 #define RG_IEEE_ADDR_3 (0x27)
00249   /** Access parameters for sub-register IEEE_ADDR_3 in register IEEE_ADDR_3 */
00250   #define SR_IEEE_ADDR_3 0x27,0xff,0
00251 /** Offset for register IEEE_ADDR_4 */
00252 #define RG_IEEE_ADDR_4 (0x28)
00253   /** Access parameters for sub-register IEEE_ADDR_4 in register IEEE_ADDR_4 */
00254   #define SR_IEEE_ADDR_4 0x28,0xff,0
00255 /** Offset for register IEEE_ADDR_5 */
00256 #define RG_IEEE_ADDR_5 (0x29)
00257   /** Access parameters for sub-register IEEE_ADDR_5 in register IEEE_ADDR_5 */
00258   #define SR_IEEE_ADDR_5 0x29,0xff,0
00259 /** Offset for register IEEE_ADDR_6 */
00260 #define RG_IEEE_ADDR_6 (0x2a)
00261   /** Access parameters for sub-register IEEE_ADDR_6 in register IEEE_ADDR_6 */
00262   #define SR_IEEE_ADDR_6 0x2a,0xff,0
00263 /** Offset for register IEEE_ADDR_7 */
00264 #define RG_IEEE_ADDR_7 (0x2b)
00265   /** Access parameters for sub-register IEEE_ADDR_7 in register IEEE_ADDR_7 */
00266   #define SR_IEEE_ADDR_7 0x2b,0xff,0
00267 /** Offset for register XAH_CTRL */
00268 #define RG_XAH_CTRL (0x2c)
00269   /** Access parameters for sub-register MAX_FRAME_RETRIES in register XAH_CTRL */
00270   #define SR_MAX_FRAME_RETRIES 0x2c,0xf0,4
00271   /** Access parameters for sub-register MAX_CSMA_RETRIES in register XAH_CTRL */
00272   #define SR_MAX_CSMA_RETRIES 0x2c,0xe,1
00273 /** Offset for register CSMA_SEED_0 */
00274 #define RG_CSMA_SEED_0 (0x2d)
00275   /** Access parameters for sub-register CSMA_SEED_0 in register CSMA_SEED_0 */
00276   #define SR_CSMA_SEED_0 0x2d,0xff,0
00277 /** Offset for register CSMA_SEED_1 */
00278 #define RG_CSMA_SEED_1 (0x2e)
00279   /** Access parameters for sub-register MIN_BE in register CSMA_SEED_1 */
00280   #define SR_MIN_BE 0x2e,0xc0,6
00281   /** Access parameters for sub-register AACK_SET_PD in register CSMA_SEED_1 */
00282   #define SR_AACK_SET_PD 0x2e,0x20,5
00283   /** Access parameters for sub-register AACK_I_AM_COORD in register CSMA_SEED_1 */
00284   #define SR_AACK_I_AM_COORD 0x2e,0x8,3
00285   /** Access parameters for sub-register CSMA_SEED_1 in register CSMA_SEED_1 */
00286   #define SR_CSMA_SEED_1 0x2e,0x7,0
00287 /** name string of the radio */
00288 #define RADIO_NAME "AT86RF230B"
00289 /** contents of the RG_PART_NUM register */
00290 #define RADIO_PART_NUM (RF230B_PART_NUM)
00291 /** contents of the RG_VERSION_NUM register */
00292 #define RADIO_VERSION_NUM (RF230B_VERSION_NUM)
00293 
00294 /** SPI command code for register write */
00295 #define TRX_CMD_RW           (_BV(7) | _BV(6))
00296 /** SPI command code for register read */
00297 #define TRX_CMD_RR           (_BV(7))
00298 /** SPI command code for frame write */
00299 #define TRX_CMD_FW           (_BV(6) | _BV(5))
00300 /** SPI command code for frame read */
00301 #define TRX_CMD_FR           (_BV(5))
00302 /** SPI command code for sram write */
00303 #define TRX_CMD_SW           (_BV(6))
00304 /** SPI command code for sram read */
00305 #define TRX_CMD_SR           (0)
00306 
00307 #define TRX_CMD_RADDR_MASK   (0x3f)
00308 
00309 /** duration while reset=low is asserted */
00310 #define TRX_RESET_TIME_US    (6)
00311 
00312 /** duration transceiver reaches TRX_OFF for the first time */
00313 #define TRX_INIT_TIME_US     (510)
00314 
00315 /** maximum duration, which PLL needs to lock */
00316 #define TRX_PLL_LOCK_TIME_US     (180)
00317 
00318 /** duration of a CCA measurement */
00319 #define TRX_CCA_TIME_US     (140)
00320 
00321 /** Mask for PLL lock interrupt */
00322 #define TRX_IRQ_PLL_LOCK   _BV(0)
00323 
00324 /** Mask for PLL unlock interrupt */
00325 #define TRX_IRQ_PLL_UNLOCK _BV(1)
00326 
00327 /** Mask for RX Start interrupt */
00328 #define TRX_IRQ_RX_START   _BV(2)
00329 
00330 /** Mask for RX/TX end interrupt */
00331 #define TRX_IRQ_TRX_END    _BV(3)
00332 
00333 /** Mask for RX/TX underrun interrupt */
00334 #define TRX_IRQ_UR         _BV(6)
00335 
00336 /** Mask for battery low interrupt */
00337 #define TRX_IRQ_BAT_LOW    _BV(7)
00338 
00339 
00340 
00341 /** lowest supported channel number */
00342 #define TRX_MIN_CHANNEL (11)
00343 
00344 /** highest supported channel number */
00345 #define TRX_MAX_CHANNEL (26)
00346 
00347 /** number of channels */
00348 #define TRX_NB_CHANNELS (16)
00349 
00350 /**
00351  * @brief Mask for supported channels of this radio.
00352  * The AT86RF230 supports channels 11 ... 26 of IEEE 802.15.4
00353  */
00354 #define TRX_SUPPORTED_CHANNELS  (0x7fff800UL)
00355 
00356 #define TRX_SUPPORTS_BAND_2400 (1)
00357 
00358 /**
00359  * @brief Mask for supported channel pages (a.k.a. modulation schemes) of this radio.
00360  * The AT86RF230 supports channel page ???? OQPSK_250
00361  */
00362 #define TRX_SUPPORTED_PAGES     (42)
00363 
00364 
00365 /** Rate code for OQPSK250, xx kchip/s, yy kbit/s */
00366 #define TRX_OQPSK250  (0)
00367 
00368 /** undefined data rate */
00369 #define TRX_NONE      (255)
00370 
00371 #endif /* ifndef AT86RF230B_H */