amiro-lld / drivers / DW1000 / v2 / decadriver / deca_device.c @ 14c96f7f
History | View | Annotate | Download (142.18 KB)
| 1 |
/*! ------------------------------------------------------------------------------------------------------------------
|
|---|---|
| 2 |
* @file deca_device.c
|
| 3 |
* @brief Decawave device configuration and control functions
|
| 4 |
*
|
| 5 |
* @attention
|
| 6 |
*
|
| 7 |
* Copyright 2013 (c) Decawave Ltd, Dublin, Ireland.
|
| 8 |
*
|
| 9 |
* All rights reserved.
|
| 10 |
*
|
| 11 |
*/
|
| 12 |
|
| 13 |
#include <assert.h> |
| 14 |
#include <stdlib.h> |
| 15 |
|
| 16 |
#include "deca_types.h" |
| 17 |
#include "deca_param_types.h" |
| 18 |
#include "deca_regs.h" |
| 19 |
#include "deca_device_api.h" |
| 20 |
|
| 21 |
// Defines for enable_clocks function
|
| 22 |
#define FORCE_SYS_XTI 0 |
| 23 |
#define ENABLE_ALL_SEQ 1 |
| 24 |
#define FORCE_SYS_PLL 2 |
| 25 |
#define READ_ACC_ON 7 |
| 26 |
#define READ_ACC_OFF 8 |
| 27 |
#define FORCE_OTP_ON 11 |
| 28 |
#define FORCE_OTP_OFF 12 |
| 29 |
#define FORCE_TX_PLL 13 |
| 30 |
#define FORCE_LDE 14 |
| 31 |
|
| 32 |
// Defines for ACK request bitmask in DATA and MAC COMMAND frame control (first byte) - Used to detect AAT bit wrongly set.
|
| 33 |
#define FCTRL_ACK_REQ_MASK 0x20 |
| 34 |
// Frame control maximum length in bytes.
|
| 35 |
#define FCTRL_LEN_MAX 2 |
| 36 |
|
| 37 |
// #define DWT_API_ERROR_CHECK // define so API checks config input parameters
|
| 38 |
|
| 39 |
// -------------------------------------------------------------------------------------------------------------------
|
| 40 |
//
|
| 41 |
// Internal functions for controlling and configuring the device
|
| 42 |
//
|
| 43 |
// -------------------------------------------------------------------------------------------------------------------
|
| 44 |
|
| 45 |
// Enable and Configure specified clocks
|
| 46 |
void _dwt_enableclocks(int clocks) ; |
| 47 |
// Configure the ucode (FP algorithm) parameters
|
| 48 |
void _dwt_configlde(int prf); |
| 49 |
// Load ucode from OTP/ROM
|
| 50 |
void _dwt_loaducodefromrom(void); |
| 51 |
// Read non-volatile memory
|
| 52 |
uint32 _dwt_otpread(uint16 address); |
| 53 |
// Program the non-volatile memory
|
| 54 |
uint32 _dwt_otpprogword32(uint32 data, uint16 address); |
| 55 |
// Upload the device configuration into always on memory
|
| 56 |
void _dwt_aonarrayupload(void); |
| 57 |
// -------------------------------------------------------------------------------------------------------------------
|
| 58 |
|
| 59 |
/*!
|
| 60 |
* Static data for DW1000 DecaWave Transceiver control
|
| 61 |
*/
|
| 62 |
|
| 63 |
// -------------------------------------------------------------------------------------------------------------------
|
| 64 |
// Structure to hold device data
|
| 65 |
typedef struct |
| 66 |
{
|
| 67 |
uint32 partID ; // IC Part ID - read during initialisation
|
| 68 |
uint32 lotID ; // IC Lot ID - read during initialisation
|
| 69 |
uint8 vBatP ; // IC V bat read during production and stored in OTP (Vmeas @ 3V3)
|
| 70 |
uint8 tempP ; // IC V temp read during production and stored in OTP (Tmeas @ 23C)
|
| 71 |
uint8 longFrames ; // Flag in non-standard long frame mode
|
| 72 |
uint8 otprev ; // OTP revision number (read during initialisation)
|
| 73 |
uint32 txFCTRL ; // Keep TX_FCTRL register config
|
| 74 |
uint32 sysCFGreg ; // Local copy of system config register
|
| 75 |
uint8 dblbuffon; // Double RX buffer mode flag
|
| 76 |
uint8 wait4resp ; // wait4response was set with last TX start command
|
| 77 |
uint16 sleep_mode; // Used for automatic reloading of LDO tune and microcode at wake-up
|
| 78 |
uint16 otp_mask ; // Local copy of the OTP mask used in dwt_initialise call
|
| 79 |
dwt_cb_data_t cbData; // Callback data structure
|
| 80 |
dwt_cb_t cbTxDone; // Callback for TX confirmation event
|
| 81 |
dwt_cb_t cbRxOk; // Callback for RX good frame event
|
| 82 |
dwt_cb_t cbRxTo; // Callback for RX timeout events
|
| 83 |
dwt_cb_t cbRxErr; // Callback for RX error events
|
| 84 |
} dwt_local_data_t ; |
| 85 |
|
| 86 |
static dwt_local_data_t dw1000local[DWT_NUM_DW_DEV] ; // Static local device data, can be an array to support multiple DW1000 testing applications/platforms |
| 87 |
static dwt_local_data_t *pdw1000local = dw1000local ; // Static local data structure pointer |
| 88 |
|
| 89 |
|
| 90 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 91 |
* @fn dwt_apiversion()
|
| 92 |
*
|
| 93 |
* @brief This function returns the version of the API as defined by DW1000_DRIVER_VERSION
|
| 94 |
*
|
| 95 |
* input parameters
|
| 96 |
*
|
| 97 |
* output parameters
|
| 98 |
*
|
| 99 |
* returns version (DW1000_DRIVER_VERSION)
|
| 100 |
*/
|
| 101 |
int32 dwt_apiversion(void)
|
| 102 |
{
|
| 103 |
return DW1000_DRIVER_VERSION ;
|
| 104 |
} |
| 105 |
|
| 106 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 107 |
* @fn dwt_setlocaldataptr()
|
| 108 |
*
|
| 109 |
* @brief This function sets the local data structure pointer to point to the element in the local array as given by the index.
|
| 110 |
*
|
| 111 |
* input parameters
|
| 112 |
* @param index - selects the array element to point to. Must be within the array bounds, i.e. < DWT_NUM_DW_DEV
|
| 113 |
*
|
| 114 |
* output parameters
|
| 115 |
*
|
| 116 |
* returns DWT_SUCCESS for success, or DWT_ERROR for error
|
| 117 |
*/
|
| 118 |
int dwt_setlocaldataptr(unsigned int index) |
| 119 |
{
|
| 120 |
// Check the index is within the array bounds
|
| 121 |
if (DWT_NUM_DW_DEV <= index) // return error if index outside the array bounds |
| 122 |
{
|
| 123 |
return DWT_ERROR ;
|
| 124 |
} |
| 125 |
|
| 126 |
pdw1000local = &dw1000local[index]; |
| 127 |
|
| 128 |
return DWT_SUCCESS ;
|
| 129 |
} |
| 130 |
|
| 131 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 132 |
* @fn dwt_initialise()
|
| 133 |
*
|
| 134 |
* @brief This function initiates communications with the DW1000 transceiver
|
| 135 |
* and reads its DEV_ID register (address 0x00) to verify the IC is one supported
|
| 136 |
* by this software (e.g. DW1000 32-bit device ID value is 0xDECA0130). Then it
|
| 137 |
* does any initial once only device configurations needed for its use and initialises
|
| 138 |
* as necessary any static data items belonging to this low-level driver.
|
| 139 |
*
|
| 140 |
* This function does not need to be called after DW1000 device is woken up from DEEPSLEEP,
|
| 141 |
* the device will preserve register values e.g. LDO, UCODE, XTAL. However if needed this
|
| 142 |
* function can be called to initialise internal structure dw1000local[] if it has not been preserved
|
| 143 |
* (e.g. if micro was in sleep and its RAM data (containing dw1000local structure was not preserved during sleep)
|
| 144 |
*
|
| 145 |
* NOTES:
|
| 146 |
* 1. When DW1000 is powered on this function needs to be run before dwt_configuresleep,
|
| 147 |
* also the SPI frequency has to be < 3MHz
|
| 148 |
* 2. It reads and applies LDO tune and crystal trim values from OTP memory
|
| 149 |
* 3. If accurate RX timestamping is needed microcode/LDE must be loaded
|
| 150 |
*
|
| 151 |
* input parameters
|
| 152 |
* @param config - specifies what configuration to load
|
| 153 |
* DWT_LOADNONE 0x00 - do not load any values from OTP memory
|
| 154 |
* DWT_LOADUCODE 0x01 - load the LDE microcode from ROM - enable accurate RX timestamp
|
| 155 |
* DWT_DW_WAKE_UP 0x02 - just initialise dw1000local[] values (e.g. DW1000 has woken up)
|
| 156 |
* DWT_DW_WUP_NO_UCODE 0x04 - if microcode/LDE algorithm has not already been loaded (on power up) e.g. when LDE is not used
|
| 157 |
* DWT_READ_OTP_PID 0x10 - read part ID from OTP
|
| 158 |
* DWT_READ_OTP_LID 0x20 - read lot ID from OTP
|
| 159 |
* DWT_READ_OTP_BAT 0x40 - read ref voltage from OTP
|
| 160 |
* DWT_READ_OTP_TMP 0x80 - read ref temperature from OTP
|
| 161 |
* output parameters
|
| 162 |
*
|
| 163 |
* returns DWT_SUCCESS for success, or DWT_ERROR for error
|
| 164 |
*/
|
| 165 |
// OTP addresses definitions
|
| 166 |
#define LDOTUNE_ADDRESS (0x04) |
| 167 |
#define PARTID_ADDRESS (0x06) |
| 168 |
#define LOTID_ADDRESS (0x07) |
| 169 |
#define VBAT_ADDRESS (0x08) |
| 170 |
#define VTEMP_ADDRESS (0x09) |
| 171 |
#define XTRIM_ADDRESS (0x1E) |
| 172 |
|
| 173 |
int dwt_initialise(int config) |
| 174 |
{
|
| 175 |
uint16 otp_xtaltrim_and_rev = 0;
|
| 176 |
uint32 ldo_tune = 0;
|
| 177 |
|
| 178 |
pdw1000local->dblbuffon = 0; // - set to 0 - meaning double buffer mode is off by default |
| 179 |
pdw1000local->wait4resp = 0; // - set to 0 - meaning wait for response not active |
| 180 |
pdw1000local->sleep_mode = 0; // - set to 0 - meaning sleep mode has not been configured |
| 181 |
|
| 182 |
pdw1000local->cbTxDone = NULL;
|
| 183 |
pdw1000local->cbRxOk = NULL;
|
| 184 |
pdw1000local->cbRxTo = NULL;
|
| 185 |
pdw1000local->cbRxErr = NULL;
|
| 186 |
|
| 187 |
#if DWT_API_ERROR_CHECK
|
| 188 |
pdw1000local->otp_mask = config ; // Save the READ_OTP config mask
|
| 189 |
#endif
|
| 190 |
|
| 191 |
// Read and validate device ID, return -1 if not recognised
|
| 192 |
if (DWT_DEVICE_ID != dwt_readdevid()) // MP IC ONLY (i.e. DW1000) FOR THIS CODE |
| 193 |
{
|
| 194 |
return DWT_ERROR ;
|
| 195 |
} |
| 196 |
|
| 197 |
if(!(DWT_DW_WAKE_UP & config)) // Don't reset the device if DWT_DW_WAKE_UP bit is set, e.g. when calling this API after wake up |
| 198 |
{
|
| 199 |
dwt_softreset(); // Make sure the device is completely reset before starting initialisation
|
| 200 |
} |
| 201 |
|
| 202 |
if(!((DWT_DW_WAKE_UP & config) && ((DWT_READ_OTP_TMP | DWT_READ_OTP_BAT | DWT_READ_OTP_LID | DWT_READ_OTP_PID | DWT_DW_WUP_RD_OTPREV)& config)))
|
| 203 |
{
|
| 204 |
_dwt_enableclocks(FORCE_SYS_XTI); // NOTE: set system clock to XTI - this is necessary to make sure the values read by _dwt_otpread are reliable
|
| 205 |
} // when not reading from OTP, clocks don't need to change.
|
| 206 |
|
| 207 |
// Configure the CPLL lock detect
|
| 208 |
dwt_write8bitoffsetreg(EXT_SYNC_ID, EC_CTRL_OFFSET, EC_CTRL_PLLLCK); |
| 209 |
|
| 210 |
// When DW1000 IC is initialised from power up, then the LDO value should be kicked from OTP, otherwise if this API is called after
|
| 211 |
// DW1000 IC has been woken up (DWT_DW_WAKE_UP bit is set) this can be skipped as LDO would have already been automatically
|
| 212 |
// kicked/loaded on wake up
|
| 213 |
if(!(DWT_DW_WAKE_UP & config))
|
| 214 |
{
|
| 215 |
// Load LDO tune from OTP and kick it if there is a value actually programmed.
|
| 216 |
ldo_tune = _dwt_otpread(LDOTUNE_ADDRESS); |
| 217 |
if((ldo_tune & 0xFF) != 0) |
| 218 |
{
|
| 219 |
// Kick LDO tune
|
| 220 |
dwt_write8bitoffsetreg(OTP_IF_ID, OTP_SF, OTP_SF_LDO_KICK); // Set load LDO kick bit
|
| 221 |
pdw1000local->sleep_mode |= AON_WCFG_ONW_LLDO; // LDO tune must be kicked at wake-up
|
| 222 |
} |
| 223 |
} |
| 224 |
else
|
| 225 |
{ //if LDOTUNE reg contains value different from default it means it was kicked from OTP and thus set AON_WCFG_ONW_LLDO.
|
| 226 |
if(dwt_read32bitoffsetreg(RF_CONF_ID, LDOTUNE) != LDOTUNE_DEFAULT)
|
| 227 |
pdw1000local->sleep_mode |= AON_WCFG_ONW_LLDO; |
| 228 |
} |
| 229 |
|
| 230 |
if((!(DWT_DW_WAKE_UP & config)) || ((DWT_DW_WAKE_UP & config) && (DWT_DW_WUP_RD_OTPREV & config)))
|
| 231 |
{
|
| 232 |
// Read OTP revision number
|
| 233 |
otp_xtaltrim_and_rev = _dwt_otpread(XTRIM_ADDRESS) & 0xffff; // Read 32 bit value, XTAL trim val is in low octet-0 (5 bits) |
| 234 |
pdw1000local->otprev = (otp_xtaltrim_and_rev >> 8) & 0xff; // OTP revision is the next byte |
| 235 |
} |
| 236 |
else
|
| 237 |
pdw1000local->otprev = 0; // If OTP valuse are not used, if this API is called after DW1000 IC has been woken up |
| 238 |
// (DWT_DW_WAKE_UP bit is set), set otprev to 0
|
| 239 |
|
| 240 |
if(!(DWT_DW_WAKE_UP & config))
|
| 241 |
{
|
| 242 |
// XTAL trim value is set in OTP for DW1000 module and EVK/TREK boards but that might not be the case in a custom design
|
| 243 |
if ((otp_xtaltrim_and_rev & 0x1F) == 0) // A value of 0 means that the crystal has not been trimmed |
| 244 |
{
|
| 245 |
otp_xtaltrim_and_rev = FS_XTALT_MIDRANGE ; // Set to mid-range if no calibration value inside
|
| 246 |
} |
| 247 |
// Configure XTAL trim
|
| 248 |
dwt_setxtaltrim((uint8)otp_xtaltrim_and_rev); |
| 249 |
} |
| 250 |
|
| 251 |
if(DWT_READ_OTP_PID & config)
|
| 252 |
{
|
| 253 |
// Load Part from OTP
|
| 254 |
pdw1000local->partID = _dwt_otpread(PARTID_ADDRESS); |
| 255 |
} |
| 256 |
else
|
| 257 |
{
|
| 258 |
pdw1000local->partID = 0;
|
| 259 |
} |
| 260 |
|
| 261 |
if(DWT_READ_OTP_LID & config)
|
| 262 |
{
|
| 263 |
// Load Lot ID from OTP
|
| 264 |
pdw1000local->lotID = _dwt_otpread(LOTID_ADDRESS); |
| 265 |
} |
| 266 |
else
|
| 267 |
{
|
| 268 |
pdw1000local->lotID = 0;
|
| 269 |
} |
| 270 |
|
| 271 |
if(DWT_READ_OTP_BAT & config)
|
| 272 |
{
|
| 273 |
// Load VBAT from OTP
|
| 274 |
pdw1000local->vBatP = _dwt_otpread(VBAT_ADDRESS) & 0xff;
|
| 275 |
} |
| 276 |
else
|
| 277 |
{
|
| 278 |
pdw1000local->vBatP = 0;
|
| 279 |
} |
| 280 |
|
| 281 |
if(DWT_READ_OTP_TMP & config)
|
| 282 |
{
|
| 283 |
// Load TEMP from OTP
|
| 284 |
pdw1000local->tempP = _dwt_otpread(VTEMP_ADDRESS) & 0xff;
|
| 285 |
} |
| 286 |
else
|
| 287 |
{
|
| 288 |
pdw1000local->tempP = 0;
|
| 289 |
} |
| 290 |
|
| 291 |
// Load leading edge detect code (LDE/microcode)
|
| 292 |
if(!(DWT_DW_WAKE_UP & config))
|
| 293 |
{
|
| 294 |
if(DWT_LOADUCODE & config)
|
| 295 |
{
|
| 296 |
_dwt_loaducodefromrom(); |
| 297 |
pdw1000local->sleep_mode |= AON_WCFG_ONW_LLDE; // microcode must be loaded at wake-up if loaded on initialisation
|
| 298 |
} |
| 299 |
else // Should disable the LDERUN bit enable if LDE has not been loaded |
| 300 |
{
|
| 301 |
uint16 rega = dwt_read16bitoffsetreg(PMSC_ID, PMSC_CTRL1_OFFSET+1) ;
|
| 302 |
rega &= 0xFDFF ; // Clear LDERUN bit |
| 303 |
dwt_write16bitoffsetreg(PMSC_ID, PMSC_CTRL1_OFFSET+1, rega) ;
|
| 304 |
} |
| 305 |
} |
| 306 |
else //if DWT_DW_WUP_NO_UCODE is set then assume that the UCODE was loaded from ROM (i.e. DWT_LOADUCODE was set on power up), |
| 307 |
{ //thus set AON_WCFG_ONW_LLDE, otherwise don't set the AON_WCFG_ONW_LLDE bit in the sleep_mode configuration
|
| 308 |
if((DWT_DW_WUP_NO_UCODE & config) == 0) |
| 309 |
{
|
| 310 |
pdw1000local->sleep_mode |= AON_WCFG_ONW_LLDE; |
| 311 |
} |
| 312 |
} |
| 313 |
|
| 314 |
_dwt_enableclocks(ENABLE_ALL_SEQ); // Enable clocks for sequencing
|
| 315 |
|
| 316 |
// The 3 bits in AON CFG1 register must be cleared to ensure proper operation of the DW1000 in DEEPSLEEP mode.
|
| 317 |
dwt_write8bitoffsetreg(AON_ID, AON_CFG1_OFFSET, 0x00);
|
| 318 |
|
| 319 |
// Read system register / store local copy
|
| 320 |
pdw1000local->sysCFGreg = dwt_read32bitreg(SYS_CFG_ID) ; // Read sysconfig register
|
| 321 |
pdw1000local->longFrames = (pdw1000local->sysCFGreg & SYS_CFG_PHR_MODE_11) >> SYS_CFG_PHR_MODE_SHFT ; //configure longFrames
|
| 322 |
|
| 323 |
pdw1000local->txFCTRL = dwt_read32bitreg(TX_FCTRL_ID) ; |
| 324 |
|
| 325 |
return DWT_SUCCESS ;
|
| 326 |
|
| 327 |
} // end dwt_initialise()
|
| 328 |
|
| 329 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 330 |
* @fn dwt_otprevision()
|
| 331 |
*
|
| 332 |
* @brief This is used to return the read OTP revision
|
| 333 |
*
|
| 334 |
* NOTE: dwt_initialise() must be called prior to this function so that it can return a relevant value.
|
| 335 |
*
|
| 336 |
* input parameters
|
| 337 |
*
|
| 338 |
* output parameters
|
| 339 |
*
|
| 340 |
* returns the read OTP revision value
|
| 341 |
*/
|
| 342 |
uint8 dwt_otprevision(void)
|
| 343 |
{
|
| 344 |
return pdw1000local->otprev ;
|
| 345 |
} |
| 346 |
|
| 347 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 348 |
* @fn dwt_setfinegraintxseq()
|
| 349 |
*
|
| 350 |
* @brief This function enables/disables the fine grain TX sequencing (enabled by default).
|
| 351 |
*
|
| 352 |
* input parameters
|
| 353 |
* @param enable - 1 to enable fine grain TX sequencing, 0 to disable it.
|
| 354 |
*
|
| 355 |
* output parameters none
|
| 356 |
*
|
| 357 |
* no return value
|
| 358 |
*/
|
| 359 |
void dwt_setfinegraintxseq(int enable) |
| 360 |
{
|
| 361 |
if (enable)
|
| 362 |
{
|
| 363 |
dwt_write16bitoffsetreg(PMSC_ID, PMSC_TXFINESEQ_OFFSET, PMSC_TXFINESEQ_ENABLE); |
| 364 |
} |
| 365 |
else
|
| 366 |
{
|
| 367 |
dwt_write16bitoffsetreg(PMSC_ID, PMSC_TXFINESEQ_OFFSET, PMSC_TXFINESEQ_DISABLE); |
| 368 |
} |
| 369 |
} |
| 370 |
|
| 371 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 372 |
* @fn dwt_setlnapamode()
|
| 373 |
*
|
| 374 |
* @brief This is used to enable GPIO for external LNA or PA functionality - HW dependent, consult the DW1000 User Manual.
|
| 375 |
* This can also be used for debug as enabling TX and RX GPIOs is quite handy to monitor DW1000's activity.
|
| 376 |
*
|
| 377 |
* NOTE: Enabling PA functionality requires that fine grain TX sequencing is deactivated. This can be done using
|
| 378 |
* dwt_setfinegraintxseq().
|
| 379 |
*
|
| 380 |
* input parameters
|
| 381 |
* @param lna_pa - bit field: bit 0 if set will enable LNA functionality,
|
| 382 |
* : bit 1 if set will enable PA functionality,
|
| 383 |
* : to disable LNA/PA set the bits to 0
|
| 384 |
*
|
| 385 |
* no return value
|
| 386 |
*/
|
| 387 |
void dwt_setlnapamode(int lna_pa) |
| 388 |
{
|
| 389 |
uint32 gpio_mode = dwt_read32bitoffsetreg(GPIO_CTRL_ID, GPIO_MODE_OFFSET); |
| 390 |
gpio_mode &= ~(GPIO_MSGP4_MASK | GPIO_MSGP5_MASK | GPIO_MSGP6_MASK); |
| 391 |
if (lna_pa & DWT_LNA_ENABLE)
|
| 392 |
{
|
| 393 |
gpio_mode |= GPIO_PIN6_EXTRXE; |
| 394 |
} |
| 395 |
if (lna_pa & DWT_PA_ENABLE)
|
| 396 |
{
|
| 397 |
gpio_mode |= (GPIO_PIN5_EXTTXE | GPIO_PIN4_EXTPA); |
| 398 |
} |
| 399 |
dwt_write32bitoffsetreg(GPIO_CTRL_ID, GPIO_MODE_OFFSET, gpio_mode); |
| 400 |
} |
| 401 |
|
| 402 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 403 |
* @fn dwt_enablegpioclocks()
|
| 404 |
*
|
| 405 |
* @brief This is used to enable GPIO clocks. The clocks are needed to ensure correct GPIO operation
|
| 406 |
*
|
| 407 |
* input parameters
|
| 408 |
*
|
| 409 |
* output parameters
|
| 410 |
*
|
| 411 |
* no return value
|
| 412 |
*/
|
| 413 |
void dwt_enablegpioclocks(void) |
| 414 |
{
|
| 415 |
uint32 pmsc_clock_ctrl = dwt_read32bitreg(PMSC_ID); |
| 416 |
dwt_write32bitreg(PMSC_ID, pmsc_clock_ctrl | PMSC_CTRL0_GPCE | PMSC_CTRL0_GPRN) ; |
| 417 |
} |
| 418 |
|
| 419 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 420 |
* @fn dwt_setgpiodirection()
|
| 421 |
*
|
| 422 |
* @brief This is used to set GPIO direction as an input (1) or output (0)
|
| 423 |
*
|
| 424 |
* input parameters
|
| 425 |
* @param gpioNum - this is the GPIO to configure - see GxM0... GxM8 in the deca_regs.h file
|
| 426 |
* @param direction - this sets the GPIO direction - see GxP0... GxP8 in the deca_regs.h file
|
| 427 |
*
|
| 428 |
* output parameters
|
| 429 |
*
|
| 430 |
* no return value
|
| 431 |
*/
|
| 432 |
void dwt_setgpiodirection(uint32 gpioNum, uint32 direction)
|
| 433 |
{
|
| 434 |
uint8 buf[GPIO_DIR_LEN]; |
| 435 |
uint32 command = direction | gpioNum; |
| 436 |
|
| 437 |
buf[0] = command & 0xff; |
| 438 |
buf[1] = (command >> 8) & 0xff; |
| 439 |
buf[2] = (command >> 16) & 0xff; |
| 440 |
|
| 441 |
dwt_writetodevice(GPIO_CTRL_ID, GPIO_DIR_OFFSET, GPIO_DIR_LEN, buf); |
| 442 |
} |
| 443 |
|
| 444 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 445 |
* @fn dwt_setgpiovalue()
|
| 446 |
*
|
| 447 |
* @brief This is used to set GPIO value as (1) or (0) only applies if the GPIO is configured as output
|
| 448 |
*
|
| 449 |
* input parameters
|
| 450 |
* @param gpioNum - this is the GPIO to configure - see DWT_GxP0... DWT_GxP8
|
| 451 |
* @param value - this sets the GPIO value - see DWT_GxP0... DWT_GxP8
|
| 452 |
*
|
| 453 |
* output parameters
|
| 454 |
*
|
| 455 |
* no return value
|
| 456 |
*/
|
| 457 |
void dwt_setgpiovalue(uint32 gpioNum, uint32 value)
|
| 458 |
{
|
| 459 |
uint8 buf[GPIO_DOUT_LEN]; |
| 460 |
uint32 command = value | gpioNum; |
| 461 |
|
| 462 |
buf[0] = command & 0xff; |
| 463 |
buf[1] = (command >> 8) & 0xff; |
| 464 |
buf[2] = (command >> 16) & 0xff; |
| 465 |
|
| 466 |
dwt_writetodevice(GPIO_CTRL_ID, GPIO_DOUT_OFFSET, GPIO_DOUT_LEN, buf); |
| 467 |
} |
| 468 |
|
| 469 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 470 |
* @fn dwt_getgpiovalue()
|
| 471 |
*
|
| 472 |
* @brief This is used to return 1 or 0 depending if the depending if the GPIO is high or low, only one GPIO should
|
| 473 |
* be tested at a time
|
| 474 |
*
|
| 475 |
* input parameters
|
| 476 |
* @param gpioNum - this is the GPIO to configure - see DWT_GxP0... DWT_GxP8
|
| 477 |
*
|
| 478 |
* output parameters
|
| 479 |
*
|
| 480 |
* return int (1 or 0)
|
| 481 |
*/
|
| 482 |
int dwt_getgpiovalue(uint32 gpioNum)
|
| 483 |
{
|
| 484 |
return ((dwt_read32bitoffsetreg(GPIO_CTRL_ID, GPIO_RAW_OFFSET) & gpioNum)? 1 : 0); |
| 485 |
} |
| 486 |
|
| 487 |
|
| 488 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 489 |
* @fn dwt_geticrefvolt()
|
| 490 |
*
|
| 491 |
* @brief This is used to return the read V measured @ 3.3 V value recorded in OTP address 0x8 (VBAT_ADDRESS)
|
| 492 |
*
|
| 493 |
* NOTE: dwt_initialise() must be called prior to this function so that it can return a relevant value.
|
| 494 |
*
|
| 495 |
* input parameters
|
| 496 |
*
|
| 497 |
* output parameters
|
| 498 |
*
|
| 499 |
* returns the 8 bit V bat value as programmed in the factory
|
| 500 |
*/
|
| 501 |
uint8 dwt_geticrefvolt(void)
|
| 502 |
{
|
| 503 |
#ifdef DWT_API_ERROR_CHECK
|
| 504 |
assert(pdw1000local->otp_mask & DWT_READ_OTP_BAT); |
| 505 |
#endif
|
| 506 |
return pdw1000local->vBatP;
|
| 507 |
} |
| 508 |
|
| 509 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 510 |
* @fn dwt_geticreftemp()
|
| 511 |
*
|
| 512 |
* @brief This is used to return the read T measured @ 23 C value recorded in OTP address 0x9 (VTEMP_ADDRESS)
|
| 513 |
*
|
| 514 |
* NOTE: dwt_initialise() must be called prior to this function so that it can return a relevant value.
|
| 515 |
*
|
| 516 |
* input parameters
|
| 517 |
*
|
| 518 |
* output parameters
|
| 519 |
*
|
| 520 |
* returns the 8 bit V temp value as programmed in the factory
|
| 521 |
*/
|
| 522 |
uint8 dwt_geticreftemp(void)
|
| 523 |
{
|
| 524 |
#ifdef DWT_API_ERROR_CHECK
|
| 525 |
assert(pdw1000local->otp_mask & DWT_READ_OTP_TMP); |
| 526 |
#endif
|
| 527 |
return pdw1000local->tempP;
|
| 528 |
} |
| 529 |
|
| 530 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 531 |
* @fn dwt_getpartid()
|
| 532 |
*
|
| 533 |
* @brief This is used to return the read part ID (or chip ID) of the device
|
| 534 |
*
|
| 535 |
* NOTE: dwt_initialise() must be called prior to this function so that it can return a relevant value (stored in OTP).
|
| 536 |
*
|
| 537 |
* input parameters
|
| 538 |
*
|
| 539 |
* output parameters
|
| 540 |
*
|
| 541 |
* returns the 32 bit part ID (or chip ID) value as programmed in the factory
|
| 542 |
*/
|
| 543 |
uint32 dwt_getpartid(void)
|
| 544 |
{
|
| 545 |
#ifdef DWT_API_ERROR_CHECK
|
| 546 |
assert(pdw1000local->otp_mask & DWT_READ_OTP_PID); |
| 547 |
#endif
|
| 548 |
|
| 549 |
return pdw1000local->partID;
|
| 550 |
} |
| 551 |
|
| 552 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 553 |
* @fn dwt_getlotid()
|
| 554 |
*
|
| 555 |
* @brief This is used to return the read lot ID of the device
|
| 556 |
*
|
| 557 |
* NOTE: dwt_initialise() must be called prior to this function so that it can return a relevant value.
|
| 558 |
*
|
| 559 |
* input parameters
|
| 560 |
*
|
| 561 |
* output parameters
|
| 562 |
*
|
| 563 |
* returns the 32 bit lot ID value as programmed in the factory
|
| 564 |
*/
|
| 565 |
uint32 dwt_getlotid(void)
|
| 566 |
{
|
| 567 |
#ifdef DWT_API_ERROR_CHECK
|
| 568 |
assert(pdw1000local->otp_mask & DWT_READ_OTP_LID); |
| 569 |
#endif
|
| 570 |
|
| 571 |
return pdw1000local->lotID;
|
| 572 |
} |
| 573 |
|
| 574 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 575 |
* @fn dwt_readdevid()
|
| 576 |
*
|
| 577 |
* @brief This is used to return the read device type and revision information of the DW1000 device (MP part is 0xDECA0130)
|
| 578 |
*
|
| 579 |
* input parameters
|
| 580 |
*
|
| 581 |
* output parameters
|
| 582 |
*
|
| 583 |
* returns the read value which for DW1000 is 0xDECA0130
|
| 584 |
*/
|
| 585 |
uint32 dwt_readdevid(void)
|
| 586 |
{
|
| 587 |
return dwt_read32bitoffsetreg(DEV_ID_ID,0); |
| 588 |
} |
| 589 |
|
| 590 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 591 |
* @fn dwt_configuretxrf()
|
| 592 |
*
|
| 593 |
* @brief This function provides the API for the configuration of the TX spectrum
|
| 594 |
* including the power and pulse generator delay. The input is a pointer to the data structure
|
| 595 |
* of type dwt_txconfig_t that holds all the configurable items.
|
| 596 |
*
|
| 597 |
* input parameters
|
| 598 |
* @param config - pointer to the txrf configuration structure, which contains the tx rf config data
|
| 599 |
*
|
| 600 |
* output parameters
|
| 601 |
*
|
| 602 |
* no return value
|
| 603 |
*/
|
| 604 |
void dwt_configuretxrf(dwt_txconfig_t *config)
|
| 605 |
{
|
| 606 |
|
| 607 |
// Configure RF TX PG_DELAY
|
| 608 |
dwt_write8bitoffsetreg(TX_CAL_ID, TC_PGDELAY_OFFSET, config->PGdly); |
| 609 |
|
| 610 |
// Configure TX power
|
| 611 |
dwt_write32bitreg(TX_POWER_ID, config->power); |
| 612 |
|
| 613 |
} |
| 614 |
|
| 615 |
|
| 616 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 617 |
* @fn dwt_configurefor64plen()
|
| 618 |
* - Use default OPS table should be used with following register modifications:
|
| 619 |
* These modifications optimise the default OPS configuration further for 64 length preamble use case
|
| 620 |
*
|
| 621 |
* NOTE: These register settings are not preserved during SLEEP/DEEPSLEEP, thus they should be programmed again after wake up
|
| 622 |
*
|
| 623 |
* input parameters
|
| 624 |
* @param prf
|
| 625 |
*
|
| 626 |
* output parameters
|
| 627 |
*
|
| 628 |
* no return value
|
| 629 |
*/
|
| 630 |
void dwt_configurefor64plen(int prf) |
| 631 |
{
|
| 632 |
dwt_write8bitoffsetreg(CRTR_ID, CRTR_GEAR_OFFSET, DEMOD_GEAR_64L); |
| 633 |
|
| 634 |
if(prf == DWT_PRF_16M)
|
| 635 |
{
|
| 636 |
dwt_write8bitoffsetreg(DRX_CONF_ID, DRX_TUNE2_OFFSET+2, DRX_TUNE2_UNCONF_SFD_TH_PRF16);
|
| 637 |
} |
| 638 |
else
|
| 639 |
{
|
| 640 |
dwt_write8bitoffsetreg(DRX_CONF_ID, DRX_TUNE2_OFFSET+2, DRX_TUNE2_UNCONF_SFD_TH_PRF64);
|
| 641 |
} |
| 642 |
} |
| 643 |
|
| 644 |
|
| 645 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 646 |
* @fn dwt_configure()
|
| 647 |
*
|
| 648 |
* @brief This function provides the main API for the configuration of the
|
| 649 |
* DW1000 and this low-level driver. The input is a pointer to the data structure
|
| 650 |
* of type dwt_config_t that holds all the configurable items.
|
| 651 |
* The dwt_config_t structure shows which ones are supported
|
| 652 |
*
|
| 653 |
* input parameters
|
| 654 |
* @param config - pointer to the configuration structure, which contains the device configuration data.
|
| 655 |
*
|
| 656 |
* output parameters
|
| 657 |
*
|
| 658 |
* no return value
|
| 659 |
*/
|
| 660 |
void dwt_configure(dwt_config_t *config)
|
| 661 |
{
|
| 662 |
uint8 nsSfd_result = 0;
|
| 663 |
uint8 useDWnsSFD = 0;
|
| 664 |
uint8 chan = config->chan ; |
| 665 |
uint32 regval ; |
| 666 |
uint16 reg16 = lde_replicaCoeff[config->rxCode]; |
| 667 |
uint8 prfIndex = config->prf - DWT_PRF_16M; |
| 668 |
uint8 bw = ((chan == 4) || (chan == 7)) ? 1 : 0 ; // Select wide or narrow band |
| 669 |
|
| 670 |
#ifdef DWT_API_ERROR_CHECK
|
| 671 |
assert(config->dataRate <= DWT_BR_6M8); |
| 672 |
assert(config->rxPAC <= DWT_PAC64); |
| 673 |
assert((chan >= 1) && (chan <= 7) && (chan != 6)); |
| 674 |
assert(((config->prf == DWT_PRF_64M) && (config->txCode >= 9) && (config->txCode <= 24)) |
| 675 |
|| ((config->prf == DWT_PRF_16M) && (config->txCode >= 1) && (config->txCode <= 8))); |
| 676 |
assert(((config->prf == DWT_PRF_64M) && (config->rxCode >= 9) && (config->rxCode <= 24)) |
| 677 |
|| ((config->prf == DWT_PRF_16M) && (config->rxCode >= 1) && (config->rxCode <= 8))); |
| 678 |
assert((config->txPreambLength == DWT_PLEN_64) || (config->txPreambLength == DWT_PLEN_128) || (config->txPreambLength == DWT_PLEN_256) |
| 679 |
|| (config->txPreambLength == DWT_PLEN_512) || (config->txPreambLength == DWT_PLEN_1024) || (config->txPreambLength == DWT_PLEN_1536) |
| 680 |
|| (config->txPreambLength == DWT_PLEN_2048) || (config->txPreambLength == DWT_PLEN_4096)); |
| 681 |
assert((config->phrMode == DWT_PHRMODE_STD) || (config->phrMode == DWT_PHRMODE_EXT)); |
| 682 |
#endif
|
| 683 |
|
| 684 |
// For 110 kbps we need a special setup
|
| 685 |
if(DWT_BR_110K == config->dataRate)
|
| 686 |
{
|
| 687 |
pdw1000local->sysCFGreg |= SYS_CFG_RXM110K ; |
| 688 |
reg16 >>= 3; // lde_replicaCoeff must be divided by 8 |
| 689 |
} |
| 690 |
else
|
| 691 |
{
|
| 692 |
pdw1000local->sysCFGreg &= (~SYS_CFG_RXM110K) ; |
| 693 |
} |
| 694 |
|
| 695 |
pdw1000local->longFrames = config->phrMode ; |
| 696 |
|
| 697 |
pdw1000local->sysCFGreg &= ~SYS_CFG_PHR_MODE_11; |
| 698 |
pdw1000local->sysCFGreg |= (SYS_CFG_PHR_MODE_11 & ((uint32)config->phrMode << SYS_CFG_PHR_MODE_SHFT)); |
| 699 |
|
| 700 |
dwt_write32bitreg(SYS_CFG_ID,pdw1000local->sysCFGreg) ; |
| 701 |
// Set the lde_replicaCoeff
|
| 702 |
dwt_write16bitoffsetreg(LDE_IF_ID, LDE_REPC_OFFSET, reg16) ; |
| 703 |
|
| 704 |
_dwt_configlde(prfIndex); |
| 705 |
|
| 706 |
// Configure PLL2/RF PLL block CFG/TUNE (for a given channel)
|
| 707 |
dwt_write32bitoffsetreg(FS_CTRL_ID, FS_PLLCFG_OFFSET, fs_pll_cfg[chan_idx[chan]]); |
| 708 |
dwt_write8bitoffsetreg(FS_CTRL_ID, FS_PLLTUNE_OFFSET, fs_pll_tune[chan_idx[chan]]); |
| 709 |
|
| 710 |
// Configure RF RX blocks (for specified channel/bandwidth)
|
| 711 |
dwt_write8bitoffsetreg(RF_CONF_ID, RF_RXCTRLH_OFFSET, rx_config[bw]); |
| 712 |
|
| 713 |
// Configure RF TX blocks (for specified channel and PRF)
|
| 714 |
// Configure RF TX control
|
| 715 |
dwt_write32bitoffsetreg(RF_CONF_ID, RF_TXCTRL_OFFSET, tx_config[chan_idx[chan]]); |
| 716 |
|
| 717 |
// Configure the baseband parameters (for specified PRF, bit rate, PAC, and SFD settings)
|
| 718 |
// DTUNE0
|
| 719 |
dwt_write16bitoffsetreg(DRX_CONF_ID, DRX_TUNE0b_OFFSET, sftsh[config->dataRate][config->nsSFD]); |
| 720 |
|
| 721 |
// DTUNE1
|
| 722 |
dwt_write16bitoffsetreg(DRX_CONF_ID, DRX_TUNE1a_OFFSET, dtune1[prfIndex]); |
| 723 |
|
| 724 |
if(config->dataRate == DWT_BR_110K)
|
| 725 |
{
|
| 726 |
dwt_write16bitoffsetreg(DRX_CONF_ID, DRX_TUNE1b_OFFSET, DRX_TUNE1b_110K); |
| 727 |
} |
| 728 |
else
|
| 729 |
{
|
| 730 |
if(config->txPreambLength == DWT_PLEN_64)
|
| 731 |
{
|
| 732 |
dwt_write16bitoffsetreg(DRX_CONF_ID, DRX_TUNE1b_OFFSET, DRX_TUNE1b_6M8_PRE64); |
| 733 |
dwt_write8bitoffsetreg(DRX_CONF_ID, DRX_TUNE4H_OFFSET, DRX_TUNE4H_PRE64); |
| 734 |
} |
| 735 |
else
|
| 736 |
{
|
| 737 |
dwt_write16bitoffsetreg(DRX_CONF_ID, DRX_TUNE1b_OFFSET, DRX_TUNE1b_850K_6M8); |
| 738 |
dwt_write8bitoffsetreg(DRX_CONF_ID, DRX_TUNE4H_OFFSET, DRX_TUNE4H_PRE128PLUS); |
| 739 |
} |
| 740 |
} |
| 741 |
|
| 742 |
// DTUNE2
|
| 743 |
dwt_write32bitoffsetreg(DRX_CONF_ID, DRX_TUNE2_OFFSET, digital_bb_config[prfIndex][config->rxPAC]); |
| 744 |
|
| 745 |
// DTUNE3 (SFD timeout)
|
| 746 |
// Don't allow 0 - SFD timeout will always be enabled
|
| 747 |
if(config->sfdTO == 0) |
| 748 |
{
|
| 749 |
config->sfdTO = DWT_SFDTOC_DEF; |
| 750 |
} |
| 751 |
dwt_write16bitoffsetreg(DRX_CONF_ID, DRX_SFDTOC_OFFSET, config->sfdTO); |
| 752 |
|
| 753 |
// Configure AGC parameters
|
| 754 |
dwt_write32bitoffsetreg( AGC_CFG_STS_ID, 0xC, agc_config.lo32);
|
| 755 |
dwt_write16bitoffsetreg( AGC_CFG_STS_ID, 0x4, agc_config.target[prfIndex]);
|
| 756 |
|
| 757 |
// Set (non-standard) user SFD for improved performance,
|
| 758 |
if(config->nsSFD)
|
| 759 |
{
|
| 760 |
// Write non standard (DW) SFD length
|
| 761 |
dwt_write8bitoffsetreg(USR_SFD_ID, 0x00, dwnsSFDlen[config->dataRate]);
|
| 762 |
nsSfd_result = 3 ;
|
| 763 |
useDWnsSFD = 1 ;
|
| 764 |
} |
| 765 |
regval = (CHAN_CTRL_TX_CHAN_MASK & (chan << CHAN_CTRL_TX_CHAN_SHIFT)) | // Transmit Channel
|
| 766 |
(CHAN_CTRL_RX_CHAN_MASK & (chan << CHAN_CTRL_RX_CHAN_SHIFT)) | // Receive Channel
|
| 767 |
(CHAN_CTRL_RXFPRF_MASK & ((uint32)config->prf << CHAN_CTRL_RXFPRF_SHIFT)) | // RX PRF
|
| 768 |
((CHAN_CTRL_TNSSFD|CHAN_CTRL_RNSSFD) & ((uint32)nsSfd_result << CHAN_CTRL_TNSSFD_SHIFT)) | // nsSFD enable RX&TX
|
| 769 |
(CHAN_CTRL_DWSFD & ((uint32)useDWnsSFD << CHAN_CTRL_DWSFD_SHIFT)) | // Use DW nsSFD
|
| 770 |
(CHAN_CTRL_TX_PCOD_MASK & ((uint32)config->txCode << CHAN_CTRL_TX_PCOD_SHIFT)) | // TX Preamble Code
|
| 771 |
(CHAN_CTRL_RX_PCOD_MASK & ((uint32)config->rxCode << CHAN_CTRL_RX_PCOD_SHIFT)) ; // RX Preamble Code
|
| 772 |
|
| 773 |
dwt_write32bitreg(CHAN_CTRL_ID,regval) ; |
| 774 |
|
| 775 |
// Set up TX Preamble Size, PRF and Data Rate
|
| 776 |
pdw1000local->txFCTRL = ((uint32)(config->txPreambLength | config->prf) << TX_FCTRL_TXPRF_SHFT) | ((uint32)config->dataRate << TX_FCTRL_TXBR_SHFT); |
| 777 |
dwt_write32bitreg(TX_FCTRL_ID, pdw1000local->txFCTRL); |
| 778 |
|
| 779 |
// The SFD transmit pattern is initialised by the DW1000 upon a user TX request, but (due to an IC issue) it is not done for an auto-ACK TX. The
|
| 780 |
// SYS_CTRL write below works around this issue, by simultaneously initiating and aborting a transmission, which correctly initialises the SFD
|
| 781 |
// after its configuration or reconfiguration.
|
| 782 |
// This issue is not documented at the time of writing this code. It should be in next release of DW1000 User Manual (v2.09, from July 2016).
|
| 783 |
dwt_write8bitoffsetreg(SYS_CTRL_ID, SYS_CTRL_OFFSET, SYS_CTRL_TXSTRT | SYS_CTRL_TRXOFF); // Request TX start and TRX off at the same time
|
| 784 |
} // end dwt_configure()
|
| 785 |
|
| 786 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 787 |
* @fn dwt_setrxantennadelay()
|
| 788 |
*
|
| 789 |
* @brief This API function writes the antenna delay (in time units) to RX registers
|
| 790 |
*
|
| 791 |
* input parameters:
|
| 792 |
* @param rxDelay - this is the total (RX) antenna delay value, which
|
| 793 |
* will be programmed into the RX register
|
| 794 |
*
|
| 795 |
* output parameters
|
| 796 |
*
|
| 797 |
* no return value
|
| 798 |
*/
|
| 799 |
void dwt_setrxantennadelay(uint16 rxDelay)
|
| 800 |
{
|
| 801 |
// Set the RX antenna delay for auto TX timestamp adjustment
|
| 802 |
dwt_write16bitoffsetreg(LDE_IF_ID, LDE_RXANTD_OFFSET, rxDelay); |
| 803 |
} |
| 804 |
|
| 805 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 806 |
* @fn dwt_settxantennadelay()
|
| 807 |
*
|
| 808 |
* @brief This API function writes the antenna delay (in time units) to TX registers
|
| 809 |
*
|
| 810 |
* input parameters:
|
| 811 |
* @param txDelay - this is the total (TX) antenna delay value, which
|
| 812 |
* will be programmed into the TX delay register
|
| 813 |
*
|
| 814 |
* output parameters
|
| 815 |
*
|
| 816 |
* no return value
|
| 817 |
*/
|
| 818 |
void dwt_settxantennadelay(uint16 txDelay)
|
| 819 |
{
|
| 820 |
// Set the TX antenna delay for auto TX timestamp adjustment
|
| 821 |
dwt_write16bitoffsetreg(TX_ANTD_ID, TX_ANTD_OFFSET, txDelay); |
| 822 |
} |
| 823 |
|
| 824 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 825 |
* @fn dwt_writetxdata()
|
| 826 |
*
|
| 827 |
* @brief This API function writes the supplied TX data into the DW1000's
|
| 828 |
* TX buffer. The input parameters are the data length in bytes and a pointer
|
| 829 |
* to those data bytes.
|
| 830 |
*
|
| 831 |
* input parameters
|
| 832 |
* @param txFrameLength - This is the total frame length, including the two byte CRC.
|
| 833 |
* Note: this is the length of TX message (including the 2 byte CRC) - max is 1023
|
| 834 |
* standard PHR mode allows up to 127 bytes
|
| 835 |
* if > 127 is programmed, DWT_PHRMODE_EXT needs to be set in the phrMode configuration
|
| 836 |
* see dwt_configure function
|
| 837 |
* @param txFrameBytes - Pointer to the user?s buffer containing the data to send.
|
| 838 |
* @param txBufferOffset - This specifies an offset in the DW1000?s TX Buffer at which to start writing data.
|
| 839 |
*
|
| 840 |
* output parameters
|
| 841 |
*
|
| 842 |
* returns DWT_SUCCESS for success, or DWT_ERROR for error
|
| 843 |
*/
|
| 844 |
int dwt_writetxdata(uint16 txFrameLength, uint8 *txFrameBytes, uint16 txBufferOffset)
|
| 845 |
{
|
| 846 |
#ifdef DWT_API_ERROR_CHECK
|
| 847 |
assert(txFrameLength >= 2);
|
| 848 |
assert((pdw1000local->longFrames && (txFrameLength <= 1023)) || (txFrameLength <= 127)); |
| 849 |
assert((txBufferOffset + txFrameLength) <= 1024);
|
| 850 |
#endif
|
| 851 |
|
| 852 |
if ((txBufferOffset + txFrameLength) <= 1024) |
| 853 |
{
|
| 854 |
// Write the data to the IC TX buffer, (-2 bytes for auto generated CRC)
|
| 855 |
dwt_writetodevice( TX_BUFFER_ID, txBufferOffset, txFrameLength-2, txFrameBytes);
|
| 856 |
return DWT_SUCCESS;
|
| 857 |
} |
| 858 |
else
|
| 859 |
{
|
| 860 |
return DWT_ERROR;
|
| 861 |
} |
| 862 |
} // end dwt_writetxdata()
|
| 863 |
|
| 864 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 865 |
* @fn dwt_writetxfctrl()
|
| 866 |
*
|
| 867 |
* @brief This API function configures the TX frame control register before the transmission of a frame
|
| 868 |
*
|
| 869 |
* input parameters:
|
| 870 |
* @param txFrameLength - this is the length of TX message (including the 2 byte CRC) - max is 1023
|
| 871 |
* NOTE: standard PHR mode allows up to 127 bytes
|
| 872 |
* if > 127 is programmed, DWT_PHRMODE_EXT needs to be set in the phrMode configuration
|
| 873 |
* see dwt_configure function
|
| 874 |
* @param txBufferOffset - the offset in the tx buffer to start writing the data
|
| 875 |
* @param ranging - 1 if this is a ranging frame, else 0
|
| 876 |
*
|
| 877 |
* output parameters
|
| 878 |
*
|
| 879 |
* no return value
|
| 880 |
*/
|
| 881 |
void dwt_writetxfctrl(uint16 txFrameLength, uint16 txBufferOffset, int ranging) |
| 882 |
{
|
| 883 |
|
| 884 |
#ifdef DWT_API_ERROR_CHECK
|
| 885 |
assert((pdw1000local->longFrames && (txFrameLength <= 1023)) || (txFrameLength <= 127)); |
| 886 |
assert((txBufferOffset + txFrameLength) <= 1024);
|
| 887 |
assert((ranging == 0) || (ranging == 1)) |
| 888 |
#endif
|
| 889 |
|
| 890 |
// Write the frame length to the TX frame control register
|
| 891 |
// pdw1000local->txFCTRL has kept configured bit rate information
|
| 892 |
uint32 reg32 = pdw1000local->txFCTRL | txFrameLength | ((uint32)txBufferOffset << TX_FCTRL_TXBOFFS_SHFT) | ((uint32)ranging << TX_FCTRL_TR_SHFT); |
| 893 |
dwt_write32bitreg(TX_FCTRL_ID, reg32); |
| 894 |
} // end dwt_writetxfctrl()
|
| 895 |
|
| 896 |
|
| 897 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 898 |
* @fn dwt_readrxdata()
|
| 899 |
*
|
| 900 |
* @brief This is used to read the data from the RX buffer, from an offset location give by offset parameter
|
| 901 |
*
|
| 902 |
* input parameters
|
| 903 |
* @param buffer - the buffer into which the data will be read
|
| 904 |
* @param length - the length of data to read (in bytes)
|
| 905 |
* @param rxBufferOffset - the offset in the rx buffer from which to read the data
|
| 906 |
*
|
| 907 |
* output parameters
|
| 908 |
*
|
| 909 |
* no return value
|
| 910 |
*/
|
| 911 |
void dwt_readrxdata(uint8 *buffer, uint16 length, uint16 rxBufferOffset)
|
| 912 |
{
|
| 913 |
dwt_readfromdevice(RX_BUFFER_ID,rxBufferOffset,length,buffer) ; |
| 914 |
} |
| 915 |
|
| 916 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 917 |
* @fn dwt_readaccdata()
|
| 918 |
*
|
| 919 |
* @brief This is used to read the data from the Accumulator buffer, from an offset location give by offset parameter
|
| 920 |
*
|
| 921 |
* NOTE: Because of an internal memory access delay when reading the accumulator the first octet output is a dummy octet
|
| 922 |
* that should be discarded. This is true no matter what sub-index the read begins at.
|
| 923 |
*
|
| 924 |
* input parameters
|
| 925 |
* @param buffer - the buffer into which the data will be read
|
| 926 |
* @param length - the length of data to read (in bytes)
|
| 927 |
* @param accOffset - the offset in the acc buffer from which to read the data
|
| 928 |
*
|
| 929 |
* output parameters
|
| 930 |
*
|
| 931 |
* no return value
|
| 932 |
*/
|
| 933 |
void dwt_readaccdata(uint8 *buffer, uint16 len, uint16 accOffset)
|
| 934 |
{
|
| 935 |
// Force on the ACC clocks if we are sequenced
|
| 936 |
_dwt_enableclocks(READ_ACC_ON); |
| 937 |
|
| 938 |
dwt_readfromdevice(ACC_MEM_ID,accOffset,len,buffer) ; |
| 939 |
|
| 940 |
_dwt_enableclocks(READ_ACC_OFF); // Revert clocks back
|
| 941 |
} |
| 942 |
|
| 943 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 944 |
* @fn dwt_readcarrierintegrator()
|
| 945 |
*
|
| 946 |
* @brief This is used to read the RX carrier integrator value (relating to the frequency offset of the TX node)
|
| 947 |
*
|
| 948 |
* NOTE: This is a 21-bit signed quantity, the function sign extends the most significant bit, which is bit #20
|
| 949 |
* (numbering from bit zero) to return a 32-bit signed integer value.
|
| 950 |
*
|
| 951 |
* input parameters - NONE
|
| 952 |
*
|
| 953 |
* return value - the (int32) signed carrier integrator value.
|
| 954 |
* A positive value means the local RX clock is running faster than the remote TX device.
|
| 955 |
*/
|
| 956 |
|
| 957 |
#define B20_SIGN_EXTEND_TEST (0x00100000UL) |
| 958 |
#define B20_SIGN_EXTEND_MASK (0xFFF00000UL) |
| 959 |
|
| 960 |
int32 dwt_readcarrierintegrator(void)
|
| 961 |
{
|
| 962 |
uint32 regval = 0 ;
|
| 963 |
int j ;
|
| 964 |
uint8 buffer[DRX_CARRIER_INT_LEN] ; |
| 965 |
|
| 966 |
/* Read 3 bytes into buffer (21-bit quantity) */
|
| 967 |
|
| 968 |
dwt_readfromdevice(DRX_CONF_ID,DRX_CARRIER_INT_OFFSET,DRX_CARRIER_INT_LEN, buffer) ; |
| 969 |
|
| 970 |
for (j = 2 ; j >= 0 ; j --) // arrange the three bytes into an unsigned integer value |
| 971 |
{
|
| 972 |
regval = (regval << 8) + buffer[j] ;
|
| 973 |
} |
| 974 |
|
| 975 |
if (regval & B20_SIGN_EXTEND_TEST) regval |= B20_SIGN_EXTEND_MASK ; // sign extend bit #20 to whole word |
| 976 |
else regval &= DRX_CARRIER_INT_MASK ; // make sure upper bits are clear if not sign extending |
| 977 |
|
| 978 |
return (int32) regval ; // cast unsigned value to signed quantity. |
| 979 |
} |
| 980 |
|
| 981 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 982 |
* @fn dwt_readdiagnostics()
|
| 983 |
*
|
| 984 |
* @brief this function reads the RX signal quality diagnostic data
|
| 985 |
*
|
| 986 |
* input parameters
|
| 987 |
* @param diagnostics - diagnostic structure pointer, this will contain the diagnostic data read from the DW1000
|
| 988 |
*
|
| 989 |
* output parameters
|
| 990 |
*
|
| 991 |
* no return value
|
| 992 |
*/
|
| 993 |
void dwt_readdiagnostics(dwt_rxdiag_t *diagnostics)
|
| 994 |
{
|
| 995 |
// Read the HW FP index
|
| 996 |
diagnostics->firstPath = dwt_read16bitoffsetreg(RX_TIME_ID, RX_TIME_FP_INDEX_OFFSET); |
| 997 |
|
| 998 |
// LDE diagnostic data
|
| 999 |
diagnostics->maxNoise = dwt_read16bitoffsetreg(LDE_IF_ID, LDE_THRESH_OFFSET); |
| 1000 |
|
| 1001 |
// Read all 8 bytes in one SPI transaction
|
| 1002 |
dwt_readfromdevice(RX_FQUAL_ID, 0x0, 8, (uint8*)&diagnostics->stdNoise); |
| 1003 |
|
| 1004 |
diagnostics->firstPathAmp1 = dwt_read16bitoffsetreg(RX_TIME_ID, RX_TIME_FP_AMPL1_OFFSET); |
| 1005 |
|
| 1006 |
diagnostics->rxPreamCount = (dwt_read32bitreg(RX_FINFO_ID) & RX_FINFO_RXPACC_MASK) >> RX_FINFO_RXPACC_SHIFT ; |
| 1007 |
} |
| 1008 |
|
| 1009 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1010 |
* @fn dwt_readtxtimestamp()
|
| 1011 |
*
|
| 1012 |
* @brief This is used to read the TX timestamp (adjusted with the programmed antenna delay)
|
| 1013 |
*
|
| 1014 |
* input parameters
|
| 1015 |
* @param timestamp - a pointer to a 5-byte buffer which will store the read TX timestamp time
|
| 1016 |
*
|
| 1017 |
* output parameters - the timestamp buffer will contain the value after the function call
|
| 1018 |
*
|
| 1019 |
* no return value
|
| 1020 |
*/
|
| 1021 |
void dwt_readtxtimestamp(uint8 * timestamp)
|
| 1022 |
{
|
| 1023 |
dwt_readfromdevice(TX_TIME_ID, TX_TIME_TX_STAMP_OFFSET, TX_TIME_TX_STAMP_LEN, timestamp) ; // Read bytes directly into buffer
|
| 1024 |
} |
| 1025 |
|
| 1026 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1027 |
* @fn dwt_readtxtimestamphi32()
|
| 1028 |
*
|
| 1029 |
* @brief This is used to read the high 32-bits of the TX timestamp (adjusted with the programmed antenna delay)
|
| 1030 |
*
|
| 1031 |
* input parameters
|
| 1032 |
*
|
| 1033 |
* output parameters
|
| 1034 |
*
|
| 1035 |
* returns high 32-bits of TX timestamp
|
| 1036 |
*/
|
| 1037 |
uint32 dwt_readtxtimestamphi32(void)
|
| 1038 |
{
|
| 1039 |
return dwt_read32bitoffsetreg(TX_TIME_ID, 1); // Offset is 1 to get the 4 upper bytes out of 5 |
| 1040 |
} |
| 1041 |
|
| 1042 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1043 |
* @fn dwt_readtxtimestamplo32()
|
| 1044 |
*
|
| 1045 |
* @brief This is used to read the low 32-bits of the TX timestamp (adjusted with the programmed antenna delay)
|
| 1046 |
*
|
| 1047 |
* input parameters
|
| 1048 |
*
|
| 1049 |
* output parameters
|
| 1050 |
*
|
| 1051 |
* returns low 32-bits of TX timestamp
|
| 1052 |
*/
|
| 1053 |
uint32 dwt_readtxtimestamplo32(void)
|
| 1054 |
{
|
| 1055 |
return dwt_read32bitreg(TX_TIME_ID); // Read TX TIME as a 32-bit register to get the 4 lower bytes out of 5 |
| 1056 |
} |
| 1057 |
|
| 1058 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1059 |
* @fn dwt_readrxtimestamp()
|
| 1060 |
*
|
| 1061 |
* @brief This is used to read the RX timestamp (adjusted time of arrival)
|
| 1062 |
*
|
| 1063 |
* input parameters
|
| 1064 |
* @param timestamp - a pointer to a 5-byte buffer which will store the read RX timestamp time
|
| 1065 |
*
|
| 1066 |
* output parameters - the timestamp buffer will contain the value after the function call
|
| 1067 |
*
|
| 1068 |
* no return value
|
| 1069 |
*/
|
| 1070 |
void dwt_readrxtimestamp(uint8 * timestamp)
|
| 1071 |
{
|
| 1072 |
dwt_readfromdevice(RX_TIME_ID, RX_TIME_RX_STAMP_OFFSET, RX_TIME_RX_STAMP_LEN, timestamp) ; // Get the adjusted time of arrival
|
| 1073 |
} |
| 1074 |
|
| 1075 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1076 |
* @fn dwt_readrxtimestamphi32()
|
| 1077 |
*
|
| 1078 |
* @brief This is used to read the high 32-bits of the RX timestamp (adjusted with the programmed antenna delay)
|
| 1079 |
*
|
| 1080 |
* input parameters
|
| 1081 |
*
|
| 1082 |
* output parameters
|
| 1083 |
*
|
| 1084 |
* returns high 32-bits of RX timestamp
|
| 1085 |
*/
|
| 1086 |
uint32 dwt_readrxtimestamphi32(void)
|
| 1087 |
{
|
| 1088 |
return dwt_read32bitoffsetreg(RX_TIME_ID, 1); // Offset is 1 to get the 4 upper bytes out of 5 |
| 1089 |
} |
| 1090 |
|
| 1091 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1092 |
* @fn dwt_readrxtimestamplo32()
|
| 1093 |
*
|
| 1094 |
* @brief This is used to read the low 32-bits of the RX timestamp (adjusted with the programmed antenna delay)
|
| 1095 |
*
|
| 1096 |
* input parameters
|
| 1097 |
*
|
| 1098 |
* output parameters
|
| 1099 |
*
|
| 1100 |
* returns low 32-bits of RX timestamp
|
| 1101 |
*/
|
| 1102 |
uint32 dwt_readrxtimestamplo32(void)
|
| 1103 |
{
|
| 1104 |
return dwt_read32bitreg(RX_TIME_ID); // Read RX TIME as a 32-bit register to get the 4 lower bytes out of 5 |
| 1105 |
} |
| 1106 |
|
| 1107 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1108 |
* @fn dwt_readsystimestamphi32()
|
| 1109 |
*
|
| 1110 |
* @brief This is used to read the high 32-bits of the system time
|
| 1111 |
*
|
| 1112 |
* input parameters
|
| 1113 |
*
|
| 1114 |
* output parameters
|
| 1115 |
*
|
| 1116 |
* returns high 32-bits of system time timestamp
|
| 1117 |
*/
|
| 1118 |
uint32 dwt_readsystimestamphi32(void)
|
| 1119 |
{
|
| 1120 |
return dwt_read32bitoffsetreg(SYS_TIME_ID, 1); // Offset is 1 to get the 4 upper bytes out of 5 |
| 1121 |
} |
| 1122 |
|
| 1123 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1124 |
* @fn dwt_readsystime()
|
| 1125 |
*
|
| 1126 |
* @brief This is used to read the system time
|
| 1127 |
*
|
| 1128 |
* input parameters
|
| 1129 |
* @param timestamp - a pointer to a 5-byte buffer which will store the read system time
|
| 1130 |
*
|
| 1131 |
* output parameters
|
| 1132 |
* @param timestamp - the timestamp buffer will contain the value after the function call
|
| 1133 |
*
|
| 1134 |
* no return value
|
| 1135 |
*/
|
| 1136 |
void dwt_readsystime(uint8 * timestamp)
|
| 1137 |
{
|
| 1138 |
dwt_readfromdevice(SYS_TIME_ID, SYS_TIME_OFFSET, SYS_TIME_LEN, timestamp) ; |
| 1139 |
} |
| 1140 |
|
| 1141 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1142 |
* @fn dwt_writetodevice()
|
| 1143 |
*
|
| 1144 |
* @brief this function is used to write to the DW1000 device registers
|
| 1145 |
* Notes:
|
| 1146 |
* 1. Firstly we create a header (the first byte is a header byte)
|
| 1147 |
* a. check if sub index is used, if subindexing is used - set bit-6 to 1 to signify that the sub-index address follows the register index byte
|
| 1148 |
* b. set bit-7 (or with 0x80) for write operation
|
| 1149 |
* c. if extended sub address index is used (i.e. if index > 127) set bit-7 of the first sub-index byte following the first header byte
|
| 1150 |
*
|
| 1151 |
* 2. Write the header followed by the data bytes to the DW1000 device
|
| 1152 |
*
|
| 1153 |
*
|
| 1154 |
* input parameters:
|
| 1155 |
* @param recordNumber - ID of register file or buffer being accessed
|
| 1156 |
* @param index - byte index into register file or buffer being accessed
|
| 1157 |
* @param length - number of bytes being written
|
| 1158 |
* @param buffer - pointer to buffer containing the 'length' bytes to be written
|
| 1159 |
*
|
| 1160 |
* output parameters
|
| 1161 |
*
|
| 1162 |
* no return value
|
| 1163 |
*/
|
| 1164 |
void dwt_writetodevice
|
| 1165 |
( |
| 1166 |
uint16 recordNumber, |
| 1167 |
uint16 index, |
| 1168 |
uint32 length, |
| 1169 |
const uint8 *buffer
|
| 1170 |
) |
| 1171 |
{
|
| 1172 |
uint8 header[3] ; // Buffer to compose header in |
| 1173 |
int cnt = 0; // Counter for length of header |
| 1174 |
#ifdef DWT_API_ERROR_CHECK
|
| 1175 |
assert(recordNumber <= 0x3F); // Record number is limited to 6-bits. |
| 1176 |
#endif
|
| 1177 |
|
| 1178 |
// Write message header selecting WRITE operation and addresses as appropriate (this is one to three bytes long)
|
| 1179 |
if (index == 0) // For index of 0, no sub-index is required |
| 1180 |
{
|
| 1181 |
header[cnt++] = 0x80 | recordNumber ; // Bit-7 is WRITE operation, bit-6 zero=NO sub-addressing, bits 5-0 is reg file id |
| 1182 |
} |
| 1183 |
else
|
| 1184 |
{
|
| 1185 |
#ifdef DWT_API_ERROR_CHECK
|
| 1186 |
assert((index <= 0x7FFF) && ((index + length) <= 0x7FFF)); // Index and sub-addressable area are limited to 15-bits. |
| 1187 |
#endif
|
| 1188 |
header[cnt++] = 0xC0 | recordNumber ; // Bit-7 is WRITE operation, bit-6 one=sub-address follows, bits 5-0 is reg file id |
| 1189 |
|
| 1190 |
if (index <= 127) // For non-zero index < 127, just a single sub-index byte is required |
| 1191 |
{
|
| 1192 |
header[cnt++] = (uint8)index ; // Bit-7 zero means no extension, bits 6-0 is index.
|
| 1193 |
} |
| 1194 |
else
|
| 1195 |
{
|
| 1196 |
header[cnt++] = 0x80 | (uint8)(index) ; // Bit-7 one means extended index, bits 6-0 is low seven bits of index. |
| 1197 |
header[cnt++] = (uint8) (index >> 7) ; // 8-bit value = high eight bits of index. |
| 1198 |
} |
| 1199 |
} |
| 1200 |
|
| 1201 |
// Write it to the SPI
|
| 1202 |
writetospi(cnt,header,length,buffer); |
| 1203 |
} // end dwt_writetodevice()
|
| 1204 |
|
| 1205 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1206 |
* @fn dwt_readfromdevice()
|
| 1207 |
*
|
| 1208 |
* @brief this function is used to read from the DW1000 device registers
|
| 1209 |
* Notes:
|
| 1210 |
* 1. Firstly we create a header (the first byte is a header byte)
|
| 1211 |
* a. check if sub index is used, if subindexing is used - set bit-6 to 1 to signify that the sub-index address follows the register index byte
|
| 1212 |
* b. set bit-7 (or with 0x80) for write operation
|
| 1213 |
* c. if extended sub address index is used (i.e. if index > 127) set bit-7 of the first sub-index byte following the first header byte
|
| 1214 |
*
|
| 1215 |
* 2. Write the header followed by the data bytes to the DW1000 device
|
| 1216 |
* 3. Store the read data in the input buffer
|
| 1217 |
*
|
| 1218 |
* input parameters:
|
| 1219 |
* @param recordNumber - ID of register file or buffer being accessed
|
| 1220 |
* @param index - byte index into register file or buffer being accessed
|
| 1221 |
* @param length - number of bytes being read
|
| 1222 |
* @param buffer - pointer to buffer in which to return the read data.
|
| 1223 |
*
|
| 1224 |
* output parameters
|
| 1225 |
*
|
| 1226 |
* no return value
|
| 1227 |
*/
|
| 1228 |
void dwt_readfromdevice
|
| 1229 |
( |
| 1230 |
uint16 recordNumber, |
| 1231 |
uint16 index, |
| 1232 |
uint32 length, |
| 1233 |
uint8 *buffer |
| 1234 |
) |
| 1235 |
{
|
| 1236 |
uint8 header[3] ; // Buffer to compose header in |
| 1237 |
int cnt = 0; // Counter for length of header |
| 1238 |
#ifdef DWT_API_ERROR_CHECK
|
| 1239 |
assert(recordNumber <= 0x3F); // Record number is limited to 6-bits. |
| 1240 |
#endif
|
| 1241 |
|
| 1242 |
// Write message header selecting READ operation and addresses as appropriate (this is one to three bytes long)
|
| 1243 |
if (index == 0) // For index of 0, no sub-index is required |
| 1244 |
{
|
| 1245 |
header[cnt++] = (uint8) recordNumber ; // Bit-7 zero is READ operation, bit-6 zero=NO sub-addressing, bits 5-0 is reg file id
|
| 1246 |
} |
| 1247 |
else
|
| 1248 |
{
|
| 1249 |
#ifdef DWT_API_ERROR_CHECK
|
| 1250 |
assert((index <= 0x7FFF) && ((index + length) <= 0x7FFF)); // Index and sub-addressable area are limited to 15-bits. |
| 1251 |
#endif
|
| 1252 |
header[cnt++] = (uint8)(0x40 | recordNumber) ; // Bit-7 zero is READ operation, bit-6 one=sub-address follows, bits 5-0 is reg file id |
| 1253 |
|
| 1254 |
if (index <= 127) // For non-zero index < 127, just a single sub-index byte is required |
| 1255 |
{
|
| 1256 |
header[cnt++] = (uint8) index ; // Bit-7 zero means no extension, bits 6-0 is index.
|
| 1257 |
} |
| 1258 |
else
|
| 1259 |
{
|
| 1260 |
header[cnt++] = 0x80 | (uint8)(index) ; // Bit-7 one means extended index, bits 6-0 is low seven bits of index. |
| 1261 |
header[cnt++] = (uint8) (index >> 7) ; // 8-bit value = high eight bits of index. |
| 1262 |
} |
| 1263 |
} |
| 1264 |
|
| 1265 |
// Do the read from the SPI
|
| 1266 |
readfromspi(cnt, header, length, buffer); // result is stored in the buffer
|
| 1267 |
} // end dwt_readfromdevice()
|
| 1268 |
|
| 1269 |
|
| 1270 |
|
| 1271 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1272 |
* @fn dwt_read32bitoffsetreg()
|
| 1273 |
*
|
| 1274 |
* @brief this function is used to read 32-bit value from the DW1000 device registers
|
| 1275 |
*
|
| 1276 |
* input parameters:
|
| 1277 |
* @param regFileID - ID of register file or buffer being accessed
|
| 1278 |
* @param regOffset - the index into register file or buffer being accessed
|
| 1279 |
*
|
| 1280 |
* output parameters
|
| 1281 |
*
|
| 1282 |
* returns 32 bit register value
|
| 1283 |
*/
|
| 1284 |
uint32 dwt_read32bitoffsetreg(int regFileID, int regOffset) |
| 1285 |
{
|
| 1286 |
uint32 regval = 0 ;
|
| 1287 |
int j ;
|
| 1288 |
uint8 buffer[4] ;
|
| 1289 |
|
| 1290 |
dwt_readfromdevice(regFileID,regOffset,4,buffer); // Read 4 bytes (32-bits) register into buffer |
| 1291 |
|
| 1292 |
for (j = 3 ; j >= 0 ; j --) |
| 1293 |
{
|
| 1294 |
regval = (regval << 8) + buffer[j] ;
|
| 1295 |
} |
| 1296 |
return regval ;
|
| 1297 |
|
| 1298 |
} // end dwt_read32bitoffsetreg()
|
| 1299 |
|
| 1300 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1301 |
* @fn dwt_read16bitoffsetreg()
|
| 1302 |
*
|
| 1303 |
* @brief this function is used to read 16-bit value from the DW1000 device registers
|
| 1304 |
*
|
| 1305 |
* input parameters:
|
| 1306 |
* @param regFileID - ID of register file or buffer being accessed
|
| 1307 |
* @param regOffset - the index into register file or buffer being accessed
|
| 1308 |
*
|
| 1309 |
* output parameters
|
| 1310 |
*
|
| 1311 |
* returns 16 bit register value
|
| 1312 |
*/
|
| 1313 |
uint16 dwt_read16bitoffsetreg(int regFileID, int regOffset) |
| 1314 |
{
|
| 1315 |
uint16 regval = 0 ;
|
| 1316 |
uint8 buffer[2] ;
|
| 1317 |
|
| 1318 |
dwt_readfromdevice(regFileID,regOffset,2,buffer); // Read 2 bytes (16-bits) register into buffer |
| 1319 |
|
| 1320 |
regval = ((uint16)buffer[1] << 8) + buffer[0] ; |
| 1321 |
return regval ;
|
| 1322 |
|
| 1323 |
} // end dwt_read16bitoffsetreg()
|
| 1324 |
|
| 1325 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1326 |
* @fn dwt_read8bitoffsetreg()
|
| 1327 |
*
|
| 1328 |
* @brief this function is used to read an 8-bit value from the DW1000 device registers
|
| 1329 |
*
|
| 1330 |
* input parameters:
|
| 1331 |
* @param regFileID - ID of register file or buffer being accessed
|
| 1332 |
* @param regOffset - the index into register file or buffer being accessed
|
| 1333 |
*
|
| 1334 |
* output parameters
|
| 1335 |
*
|
| 1336 |
* returns 8-bit register value
|
| 1337 |
*/
|
| 1338 |
uint8 dwt_read8bitoffsetreg(int regFileID, int regOffset) |
| 1339 |
{
|
| 1340 |
uint8 regval; |
| 1341 |
|
| 1342 |
dwt_readfromdevice(regFileID, regOffset, 1, ®val);
|
| 1343 |
|
| 1344 |
return regval ;
|
| 1345 |
} |
| 1346 |
|
| 1347 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1348 |
* @fn dwt_write8bitoffsetreg()
|
| 1349 |
*
|
| 1350 |
* @brief this function is used to write an 8-bit value to the DW1000 device registers
|
| 1351 |
*
|
| 1352 |
* input parameters:
|
| 1353 |
* @param regFileID - ID of register file or buffer being accessed
|
| 1354 |
* @param regOffset - the index into register file or buffer being accessed
|
| 1355 |
* @param regval - the value to write
|
| 1356 |
*
|
| 1357 |
* output parameters
|
| 1358 |
*
|
| 1359 |
* no return value
|
| 1360 |
*/
|
| 1361 |
void dwt_write8bitoffsetreg(int regFileID, int regOffset, uint8 regval) |
| 1362 |
{
|
| 1363 |
dwt_writetodevice(regFileID, regOffset, 1, ®val);
|
| 1364 |
} |
| 1365 |
|
| 1366 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1367 |
* @fn dwt_write16bitoffsetreg()
|
| 1368 |
*
|
| 1369 |
* @brief this function is used to write 16-bit value to the DW1000 device registers
|
| 1370 |
*
|
| 1371 |
* input parameters:
|
| 1372 |
* @param regFileID - ID of register file or buffer being accessed
|
| 1373 |
* @param regOffset - the index into register file or buffer being accessed
|
| 1374 |
* @param regval - the value to write
|
| 1375 |
*
|
| 1376 |
* output parameters
|
| 1377 |
*
|
| 1378 |
* no return value
|
| 1379 |
*/
|
| 1380 |
void dwt_write16bitoffsetreg(int regFileID, int regOffset, uint16 regval) |
| 1381 |
{
|
| 1382 |
uint8 buffer[2] ;
|
| 1383 |
|
| 1384 |
buffer[0] = regval & 0xFF; |
| 1385 |
buffer[1] = regval >> 8 ; |
| 1386 |
|
| 1387 |
dwt_writetodevice(regFileID,regOffset,2,buffer);
|
| 1388 |
} // end dwt_write16bitoffsetreg()
|
| 1389 |
|
| 1390 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1391 |
* @fn dwt_write32bitoffsetreg()
|
| 1392 |
*
|
| 1393 |
* @brief this function is used to write 32-bit value to the DW1000 device registers
|
| 1394 |
*
|
| 1395 |
* input parameters:
|
| 1396 |
* @param regFileID - ID of register file or buffer being accessed
|
| 1397 |
* @param regOffset - the index into register file or buffer being accessed
|
| 1398 |
* @param regval - the value to write
|
| 1399 |
*
|
| 1400 |
* output parameters
|
| 1401 |
*
|
| 1402 |
* no return value
|
| 1403 |
*/
|
| 1404 |
void dwt_write32bitoffsetreg(int regFileID, int regOffset, uint32 regval) |
| 1405 |
{
|
| 1406 |
int j ;
|
| 1407 |
uint8 buffer[4] ;
|
| 1408 |
|
| 1409 |
for ( j = 0 ; j < 4 ; j++ ) |
| 1410 |
{
|
| 1411 |
buffer[j] = regval & 0xff ;
|
| 1412 |
regval >>= 8 ;
|
| 1413 |
} |
| 1414 |
|
| 1415 |
dwt_writetodevice(regFileID,regOffset,4,buffer);
|
| 1416 |
} // end dwt_write32bitoffsetreg()
|
| 1417 |
|
| 1418 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1419 |
* @fn dwt_enableframefilter()
|
| 1420 |
*
|
| 1421 |
* @brief This is used to enable the frame filtering - (the default option is to
|
| 1422 |
* accept any data and ACK frames with correct destination address
|
| 1423 |
*
|
| 1424 |
* input parameters
|
| 1425 |
* @param - bitmask - enables/disables the frame filtering options according to
|
| 1426 |
* DWT_FF_NOTYPE_EN 0x000 no frame types allowed
|
| 1427 |
* DWT_FF_COORD_EN 0x002 behave as coordinator (can receive frames with no destination address (PAN ID has to match))
|
| 1428 |
* DWT_FF_BEACON_EN 0x004 beacon frames allowed
|
| 1429 |
* DWT_FF_DATA_EN 0x008 data frames allowed
|
| 1430 |
* DWT_FF_ACK_EN 0x010 ack frames allowed
|
| 1431 |
* DWT_FF_MAC_EN 0x020 mac control frames allowed
|
| 1432 |
* DWT_FF_RSVD_EN 0x040 reserved frame types allowed
|
| 1433 |
*
|
| 1434 |
* output parameters
|
| 1435 |
*
|
| 1436 |
* no return value
|
| 1437 |
*/
|
| 1438 |
void dwt_enableframefilter(uint16 enable)
|
| 1439 |
{
|
| 1440 |
uint32 sysconfig = SYS_CFG_MASK & dwt_read32bitreg(SYS_CFG_ID) ; // Read sysconfig register
|
| 1441 |
|
| 1442 |
if(enable)
|
| 1443 |
{
|
| 1444 |
// Enable frame filtering and configure frame types
|
| 1445 |
sysconfig &= ~(SYS_CFG_FF_ALL_EN); // Clear all
|
| 1446 |
sysconfig |= (enable & SYS_CFG_FF_ALL_EN) | SYS_CFG_FFE; |
| 1447 |
} |
| 1448 |
else
|
| 1449 |
{
|
| 1450 |
sysconfig &= ~(SYS_CFG_FFE); |
| 1451 |
} |
| 1452 |
|
| 1453 |
pdw1000local->sysCFGreg = sysconfig ; |
| 1454 |
dwt_write32bitreg(SYS_CFG_ID,sysconfig) ; |
| 1455 |
} |
| 1456 |
|
| 1457 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1458 |
* @fn dwt_setpanid()
|
| 1459 |
*
|
| 1460 |
* @brief This is used to set the PAN ID
|
| 1461 |
*
|
| 1462 |
* input parameters
|
| 1463 |
* @param panID - this is the PAN ID
|
| 1464 |
*
|
| 1465 |
* output parameters
|
| 1466 |
*
|
| 1467 |
* no return value
|
| 1468 |
*/
|
| 1469 |
void dwt_setpanid(uint16 panID)
|
| 1470 |
{
|
| 1471 |
// PAN ID is high 16 bits of register
|
| 1472 |
dwt_write16bitoffsetreg(PANADR_ID, PANADR_PAN_ID_OFFSET, panID); |
| 1473 |
} |
| 1474 |
|
| 1475 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1476 |
* @fn dwt_setaddress16()
|
| 1477 |
*
|
| 1478 |
* @brief This is used to set 16-bit (short) address
|
| 1479 |
*
|
| 1480 |
* input parameters
|
| 1481 |
* @param shortAddress - this sets the 16 bit short address
|
| 1482 |
*
|
| 1483 |
* output parameters
|
| 1484 |
*
|
| 1485 |
* no return value
|
| 1486 |
*/
|
| 1487 |
void dwt_setaddress16(uint16 shortAddress)
|
| 1488 |
{
|
| 1489 |
// Short address into low 16 bits
|
| 1490 |
dwt_write16bitoffsetreg(PANADR_ID, PANADR_SHORT_ADDR_OFFSET, shortAddress); |
| 1491 |
} |
| 1492 |
|
| 1493 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1494 |
* @fn dwt_seteui()
|
| 1495 |
*
|
| 1496 |
* @brief This is used to set the EUI 64-bit (long) address
|
| 1497 |
*
|
| 1498 |
* input parameters
|
| 1499 |
* @param eui64 - this is the pointer to a buffer that contains the 64bit address
|
| 1500 |
*
|
| 1501 |
* output parameters
|
| 1502 |
*
|
| 1503 |
* no return value
|
| 1504 |
*/
|
| 1505 |
void dwt_seteui(uint8 *eui64)
|
| 1506 |
{
|
| 1507 |
dwt_writetodevice(EUI_64_ID, EUI_64_OFFSET, EUI_64_LEN, eui64); |
| 1508 |
} |
| 1509 |
|
| 1510 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1511 |
* @fn dwt_geteui()
|
| 1512 |
*
|
| 1513 |
* @brief This is used to get the EUI 64-bit from the DW1000
|
| 1514 |
*
|
| 1515 |
* input parameters
|
| 1516 |
* @param eui64 - this is the pointer to a buffer that will contain the read 64-bit EUI value
|
| 1517 |
*
|
| 1518 |
* output parameters
|
| 1519 |
*
|
| 1520 |
* no return value
|
| 1521 |
*/
|
| 1522 |
void dwt_geteui(uint8 *eui64)
|
| 1523 |
{
|
| 1524 |
dwt_readfromdevice(EUI_64_ID, EUI_64_OFFSET, EUI_64_LEN, eui64); |
| 1525 |
} |
| 1526 |
|
| 1527 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1528 |
* @fn dwt_otpread()
|
| 1529 |
*
|
| 1530 |
* @brief This is used to read the OTP data from given address into provided array
|
| 1531 |
*
|
| 1532 |
* input parameters
|
| 1533 |
* @param address - this is the OTP address to read from
|
| 1534 |
* @param array - this is the pointer to the array into which to read the data
|
| 1535 |
* @param length - this is the number of 32 bit words to read (array needs to be at least this length)
|
| 1536 |
*
|
| 1537 |
* output parameters
|
| 1538 |
*
|
| 1539 |
* no return value
|
| 1540 |
*/
|
| 1541 |
void dwt_otpread(uint16 address, uint32 *array, uint8 length)
|
| 1542 |
{
|
| 1543 |
int i;
|
| 1544 |
|
| 1545 |
_dwt_enableclocks(FORCE_SYS_XTI); // NOTE: Set system clock to XTAL - this is necessary to make sure the values read by _dwt_otpread are reliable
|
| 1546 |
|
| 1547 |
for(i=0; i<length; i++) |
| 1548 |
{
|
| 1549 |
array[i] = _dwt_otpread(address + i) ; |
| 1550 |
} |
| 1551 |
|
| 1552 |
_dwt_enableclocks(ENABLE_ALL_SEQ); // Restore system clock to PLL
|
| 1553 |
|
| 1554 |
return ;
|
| 1555 |
} |
| 1556 |
|
| 1557 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1558 |
* @fn _dwt_otpread()
|
| 1559 |
*
|
| 1560 |
* @brief function to read the OTP memory. Ensure that MR,MRa,MRb are reset to 0.
|
| 1561 |
*
|
| 1562 |
* input parameters
|
| 1563 |
* @param address - address to read at
|
| 1564 |
*
|
| 1565 |
* output parameters
|
| 1566 |
*
|
| 1567 |
* returns the 32bit of read data
|
| 1568 |
*/
|
| 1569 |
uint32 _dwt_otpread(uint16 address) |
| 1570 |
{
|
| 1571 |
uint32 ret_data; |
| 1572 |
|
| 1573 |
// Write the address
|
| 1574 |
dwt_write16bitoffsetreg(OTP_IF_ID, OTP_ADDR, address); |
| 1575 |
|
| 1576 |
// Perform OTP Read - Manual read mode has to be set
|
| 1577 |
dwt_write8bitoffsetreg(OTP_IF_ID, OTP_CTRL, OTP_CTRL_OTPREAD | OTP_CTRL_OTPRDEN); |
| 1578 |
dwt_write8bitoffsetreg(OTP_IF_ID, OTP_CTRL, 0x00); // OTPREAD is self clearing but OTPRDEN is not |
| 1579 |
|
| 1580 |
// Read read data, available 40ns after rising edge of OTP_READ
|
| 1581 |
ret_data = dwt_read32bitoffsetreg(OTP_IF_ID, OTP_RDAT); |
| 1582 |
|
| 1583 |
// Return the 32bit of read data
|
| 1584 |
return ret_data;
|
| 1585 |
} |
| 1586 |
|
| 1587 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1588 |
* @fn _dwt_otpsetmrregs()
|
| 1589 |
*
|
| 1590 |
* @brief Configure the MR registers for initial programming (enable charge pump).
|
| 1591 |
* Read margin is used to stress the read back from the
|
| 1592 |
* programmed bit. In normal operation this is relaxed.
|
| 1593 |
*
|
| 1594 |
* input parameters
|
| 1595 |
* @param mode - "0" : Reset all to 0x0: MRA=0x0000, MRB=0x0000, MR=0x0000
|
| 1596 |
* "1" : Set for inital programming: MRA=0x9220, MRB=0x000E, MR=0x1024
|
| 1597 |
* "2" : Set for soak programming: MRA=0x9220, MRB=0x0003, MR=0x1824
|
| 1598 |
* "3" : High Vpp: MRA=0x9220, MRB=0x004E, MR=0x1824
|
| 1599 |
* "4" : Low Read Margin: MRA=0x0000, MRB=0x0003, MR=0x0000
|
| 1600 |
* "5" : Array Clean: MRA=0x0049, MRB=0x0003, MR=0x0024
|
| 1601 |
* "4" : Very Low Read Margin: MRA=0x0000, MRB=0x0003, MR=0x0000
|
| 1602 |
*
|
| 1603 |
* output parameters
|
| 1604 |
*
|
| 1605 |
* returns DWT_SUCCESS for success, or DWT_ERROR for error
|
| 1606 |
*/
|
| 1607 |
uint32 _dwt_otpsetmrregs(int mode)
|
| 1608 |
{
|
| 1609 |
uint8 wr_buf[4];
|
| 1610 |
uint32 mra=0,mrb=0,mr=0; |
| 1611 |
|
| 1612 |
// PROGRAMME MRA
|
| 1613 |
// Set MRA, MODE_SEL
|
| 1614 |
wr_buf[0] = 0x03; |
| 1615 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL+1,1,wr_buf); |
| 1616 |
|
| 1617 |
// Load data
|
| 1618 |
switch(mode&0x0f) { |
| 1619 |
case 0x0 : |
| 1620 |
mr =0x0000;
|
| 1621 |
mra=0x0000;
|
| 1622 |
mrb=0x0000;
|
| 1623 |
break;
|
| 1624 |
case 0x1 : |
| 1625 |
mr =0x1024;
|
| 1626 |
mra=0x9220; // Enable CPP mon |
| 1627 |
mrb=0x000e;
|
| 1628 |
break;
|
| 1629 |
case 0x2 : |
| 1630 |
mr =0x1824;
|
| 1631 |
mra=0x9220;
|
| 1632 |
mrb=0x0003;
|
| 1633 |
break;
|
| 1634 |
case 0x3 : |
| 1635 |
mr =0x1824;
|
| 1636 |
mra=0x9220;
|
| 1637 |
mrb=0x004e;
|
| 1638 |
break;
|
| 1639 |
case 0x4 : |
| 1640 |
mr =0x0000;
|
| 1641 |
mra=0x0000;
|
| 1642 |
mrb=0x0003;
|
| 1643 |
break;
|
| 1644 |
case 0x5 : |
| 1645 |
mr =0x0024;
|
| 1646 |
mra=0x0000;
|
| 1647 |
mrb=0x0003;
|
| 1648 |
break;
|
| 1649 |
default :
|
| 1650 |
return DWT_ERROR;
|
| 1651 |
} |
| 1652 |
|
| 1653 |
wr_buf[0] = mra & 0x00ff; |
| 1654 |
wr_buf[1] = (mra & 0xff00)>>8; |
| 1655 |
dwt_writetodevice(OTP_IF_ID, OTP_WDAT,2,wr_buf);
|
| 1656 |
|
| 1657 |
|
| 1658 |
// Set WRITE_MR
|
| 1659 |
wr_buf[0] = 0x08; |
| 1660 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL,1,wr_buf);
|
| 1661 |
|
| 1662 |
// Wait?
|
| 1663 |
deca_sleep(2);
|
| 1664 |
|
| 1665 |
// Set Clear Mode sel
|
| 1666 |
wr_buf[0] = 0x02; |
| 1667 |
dwt_writetodevice(OTP_IF_ID,OTP_CTRL+1,1,wr_buf); |
| 1668 |
|
| 1669 |
// Set AUX update, write MR
|
| 1670 |
wr_buf[0] = 0x88; |
| 1671 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL,1,wr_buf);
|
| 1672 |
// Clear write MR
|
| 1673 |
wr_buf[0] = 0x80; |
| 1674 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL,1,wr_buf);
|
| 1675 |
// Clear AUX update
|
| 1676 |
wr_buf[0] = 0x00; |
| 1677 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL,1,wr_buf);
|
| 1678 |
|
| 1679 |
///////////////////////////////////////////
|
| 1680 |
// PROGRAM MRB
|
| 1681 |
// Set SLOW, MRB, MODE_SEL
|
| 1682 |
wr_buf[0] = 0x05; |
| 1683 |
dwt_writetodevice(OTP_IF_ID,OTP_CTRL+1,1,wr_buf); |
| 1684 |
|
| 1685 |
wr_buf[0] = mrb & 0x00ff; |
| 1686 |
wr_buf[1] = (mrb & 0xff00)>>8; |
| 1687 |
dwt_writetodevice(OTP_IF_ID, OTP_WDAT,2,wr_buf);
|
| 1688 |
|
| 1689 |
// Set WRITE_MR
|
| 1690 |
wr_buf[0] = 0x08; |
| 1691 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL,1,wr_buf);
|
| 1692 |
|
| 1693 |
// Wait?
|
| 1694 |
deca_sleep(2);
|
| 1695 |
|
| 1696 |
// Set Clear Mode sel
|
| 1697 |
wr_buf[0] = 0x04; |
| 1698 |
dwt_writetodevice(OTP_IF_ID,OTP_CTRL+1,1,wr_buf); |
| 1699 |
|
| 1700 |
// Set AUX update, write MR
|
| 1701 |
wr_buf[0] = 0x88; |
| 1702 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL,1,wr_buf);
|
| 1703 |
// Clear write MR
|
| 1704 |
wr_buf[0] = 0x80; |
| 1705 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL,1,wr_buf);
|
| 1706 |
// Clear AUX update
|
| 1707 |
wr_buf[0] = 0x00; |
| 1708 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL,1,wr_buf);
|
| 1709 |
|
| 1710 |
///////////////////////////////////////////
|
| 1711 |
// PROGRAM MR
|
| 1712 |
// Set SLOW, MODE_SEL
|
| 1713 |
wr_buf[0] = 0x01; |
| 1714 |
dwt_writetodevice(OTP_IF_ID,OTP_CTRL+1,1,wr_buf); |
| 1715 |
// Load data
|
| 1716 |
|
| 1717 |
wr_buf[0] = mr & 0x00ff; |
| 1718 |
wr_buf[1] = (mr & 0xff00)>>8; |
| 1719 |
dwt_writetodevice(OTP_IF_ID, OTP_WDAT,2,wr_buf);
|
| 1720 |
|
| 1721 |
// Set WRITE_MR
|
| 1722 |
wr_buf[0] = 0x08; |
| 1723 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL,1,wr_buf);
|
| 1724 |
|
| 1725 |
// Wait?
|
| 1726 |
deca_sleep(2);
|
| 1727 |
// Set Clear Mode sel
|
| 1728 |
wr_buf[0] = 0x00; |
| 1729 |
dwt_writetodevice(OTP_IF_ID,OTP_CTRL+1,1,wr_buf); |
| 1730 |
|
| 1731 |
return DWT_SUCCESS;
|
| 1732 |
} |
| 1733 |
|
| 1734 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1735 |
* @fn _dwt_otpprogword32()
|
| 1736 |
*
|
| 1737 |
* @brief function to program the OTP memory. Ensure that MR,MRa,MRb are reset to 0.
|
| 1738 |
* VNM Charge pump needs to be enabled (see _dwt_otpsetmrregs)
|
| 1739 |
* Note the address is only 11 bits long.
|
| 1740 |
*
|
| 1741 |
* input parameters
|
| 1742 |
* @param address - address to read at
|
| 1743 |
*
|
| 1744 |
* output parameters
|
| 1745 |
*
|
| 1746 |
* returns DWT_SUCCESS for success, or DWT_ERROR for error
|
| 1747 |
*/
|
| 1748 |
uint32 _dwt_otpprogword32(uint32 data, uint16 address) |
| 1749 |
{
|
| 1750 |
uint8 rd_buf[1];
|
| 1751 |
uint8 wr_buf[4];
|
| 1752 |
uint8 otp_done; |
| 1753 |
|
| 1754 |
// Write the data
|
| 1755 |
wr_buf[3] = (data>>24) & 0xff; |
| 1756 |
wr_buf[2] = (data>>16) & 0xff; |
| 1757 |
wr_buf[1] = (data>>8) & 0xff; |
| 1758 |
wr_buf[0] = data & 0xff; |
| 1759 |
dwt_writetodevice(OTP_IF_ID, OTP_WDAT, 4, wr_buf);
|
| 1760 |
|
| 1761 |
// Write the address [10:0]
|
| 1762 |
wr_buf[1] = (address>>8) & 0x07; |
| 1763 |
wr_buf[0] = address & 0xff; |
| 1764 |
dwt_writetodevice(OTP_IF_ID, OTP_ADDR, 2, wr_buf);
|
| 1765 |
|
| 1766 |
// Enable Sequenced programming
|
| 1767 |
wr_buf[0] = OTP_CTRL_OTPPROG;
|
| 1768 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL, 1, wr_buf);
|
| 1769 |
wr_buf[0] = 0x00; // And clear |
| 1770 |
dwt_writetodevice(OTP_IF_ID, OTP_CTRL, 1, wr_buf);
|
| 1771 |
|
| 1772 |
// WAIT for status to flag PRGM OK..
|
| 1773 |
otp_done = 0;
|
| 1774 |
while(otp_done == 0) |
| 1775 |
{
|
| 1776 |
deca_sleep(1);
|
| 1777 |
dwt_readfromdevice(OTP_IF_ID, OTP_STAT, 1, rd_buf);
|
| 1778 |
|
| 1779 |
if((rd_buf[0] & 0x01) == 0x01) |
| 1780 |
{
|
| 1781 |
otp_done = 1;
|
| 1782 |
} |
| 1783 |
} |
| 1784 |
|
| 1785 |
return DWT_SUCCESS;
|
| 1786 |
} |
| 1787 |
|
| 1788 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1789 |
* @fn dwt_otpwriteandverify()
|
| 1790 |
*
|
| 1791 |
* @brief This is used to program 32-bit value into the DW1000 OTP memory.
|
| 1792 |
*
|
| 1793 |
* input parameters
|
| 1794 |
* @param value - this is the 32-bit value to be programmed into OTP
|
| 1795 |
* @param address - this is the 16-bit OTP address into which the 32-bit value is programmed
|
| 1796 |
*
|
| 1797 |
* output parameters
|
| 1798 |
*
|
| 1799 |
* returns DWT_SUCCESS for success, or DWT_ERROR for error
|
| 1800 |
*/
|
| 1801 |
int dwt_otpwriteandverify(uint32 value, uint16 address)
|
| 1802 |
{
|
| 1803 |
int prog_ok = DWT_SUCCESS;
|
| 1804 |
int retry = 0; |
| 1805 |
// Firstly set the system clock to crystal
|
| 1806 |
_dwt_enableclocks(FORCE_SYS_XTI); //set system clock to XTI
|
| 1807 |
|
| 1808 |
//
|
| 1809 |
//!!!!!!!!!!!!!! NOTE !!!!!!!!!!!!!!!!!!!!!
|
| 1810 |
//Set the supply to 3.7V
|
| 1811 |
//
|
| 1812 |
|
| 1813 |
_dwt_otpsetmrregs(1); // Set mode for programming |
| 1814 |
|
| 1815 |
// For each value to program - the readback/check is done couple of times to verify it has programmed successfully
|
| 1816 |
while(1) |
| 1817 |
{
|
| 1818 |
_dwt_otpprogword32(value, address); |
| 1819 |
|
| 1820 |
if(_dwt_otpread(address) == value)
|
| 1821 |
{
|
| 1822 |
break;
|
| 1823 |
} |
| 1824 |
retry++; |
| 1825 |
if(retry==10) |
| 1826 |
{
|
| 1827 |
break;
|
| 1828 |
} |
| 1829 |
} |
| 1830 |
|
| 1831 |
// Even if the above does not exit before retry reaches 10, the programming has probably been successful
|
| 1832 |
|
| 1833 |
_dwt_otpsetmrregs(4); // Set mode for reading |
| 1834 |
|
| 1835 |
if(_dwt_otpread(address) != value) // If this does not pass please check voltage supply on VDDIO |
| 1836 |
{
|
| 1837 |
prog_ok = DWT_ERROR; |
| 1838 |
} |
| 1839 |
|
| 1840 |
_dwt_otpsetmrregs(0); // Setting OTP mode register for low RM read - resetting the device would be alternative |
| 1841 |
|
| 1842 |
return prog_ok;
|
| 1843 |
} |
| 1844 |
|
| 1845 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1846 |
* @fn _dwt_aonconfigupload()
|
| 1847 |
*
|
| 1848 |
* @brief This function uploads always on (AON) configuration, as set in the AON_CFG0_OFFSET register.
|
| 1849 |
*
|
| 1850 |
* input parameters
|
| 1851 |
*
|
| 1852 |
* output parameters
|
| 1853 |
*
|
| 1854 |
* no return value
|
| 1855 |
*/
|
| 1856 |
void _dwt_aonconfigupload(void) |
| 1857 |
{
|
| 1858 |
dwt_write8bitoffsetreg(AON_ID, AON_CTRL_OFFSET, AON_CTRL_UPL_CFG); |
| 1859 |
dwt_write8bitoffsetreg(AON_ID, AON_CTRL_OFFSET, 0x00); // Clear the register |
| 1860 |
} |
| 1861 |
|
| 1862 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1863 |
* @fn _dwt_aonarrayupload()
|
| 1864 |
*
|
| 1865 |
* @brief This function uploads always on (AON) data array and configuration. Thus if this function is used, then _dwt_aonconfigupload
|
| 1866 |
* is not necessary. The DW1000 will go so SLEEP straight after this if the DWT_SLP_EN has been set.
|
| 1867 |
*
|
| 1868 |
* input parameters
|
| 1869 |
*
|
| 1870 |
* output parameters
|
| 1871 |
*
|
| 1872 |
* no return value
|
| 1873 |
*/
|
| 1874 |
void _dwt_aonarrayupload(void) |
| 1875 |
{
|
| 1876 |
dwt_write8bitoffsetreg(AON_ID, AON_CTRL_OFFSET, 0x00); // Clear the register |
| 1877 |
dwt_write8bitoffsetreg(AON_ID, AON_CTRL_OFFSET, AON_CTRL_SAVE); |
| 1878 |
} |
| 1879 |
|
| 1880 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1881 |
* @fn dwt_entersleep()
|
| 1882 |
*
|
| 1883 |
* @brief This function puts the device into deep sleep or sleep. dwt_configuresleep() should be called first
|
| 1884 |
* to configure the sleep and on-wake/wake-up parameters
|
| 1885 |
*
|
| 1886 |
* input parameters
|
| 1887 |
*
|
| 1888 |
* output parameters
|
| 1889 |
*
|
| 1890 |
* no return value
|
| 1891 |
*/
|
| 1892 |
void dwt_entersleep(void) |
| 1893 |
{
|
| 1894 |
// Copy config to AON - upload the new configuration
|
| 1895 |
_dwt_aonarrayupload(); |
| 1896 |
} |
| 1897 |
|
| 1898 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1899 |
* @fn dwt_configuresleepcnt()
|
| 1900 |
*
|
| 1901 |
* @brief sets the sleep counter to new value, this function programs the high 16-bits of the 28-bit counter
|
| 1902 |
*
|
| 1903 |
* NOTE: this function needs to be run before dwt_configuresleep, also the SPI frequency has to be < 3MHz
|
| 1904 |
*
|
| 1905 |
* input parameters
|
| 1906 |
* @param sleepcnt - this it value of the sleep counter to program
|
| 1907 |
*
|
| 1908 |
* output parameters
|
| 1909 |
*
|
| 1910 |
* no return value
|
| 1911 |
*/
|
| 1912 |
void dwt_configuresleepcnt(uint16 sleepcnt)
|
| 1913 |
{
|
| 1914 |
// Force system clock to crystal
|
| 1915 |
_dwt_enableclocks(FORCE_SYS_XTI); |
| 1916 |
|
| 1917 |
// Reset sleep configuration to make sure we don't accidentally go to sleep
|
| 1918 |
dwt_write8bitoffsetreg(AON_ID, AON_CFG0_OFFSET, 0x00); // NB: this write change the default LPCLKDIVA value which is not used anyway. |
| 1919 |
dwt_write8bitoffsetreg(AON_ID, AON_CFG1_OFFSET, 0x00);
|
| 1920 |
|
| 1921 |
// Disable the sleep counter
|
| 1922 |
_dwt_aonconfigupload(); |
| 1923 |
|
| 1924 |
// Set new value
|
| 1925 |
dwt_write16bitoffsetreg(AON_ID, AON_CFG0_OFFSET + AON_CFG0_SLEEP_TIM_OFFSET, sleepcnt); |
| 1926 |
_dwt_aonconfigupload(); |
| 1927 |
|
| 1928 |
// Enable the sleep counter
|
| 1929 |
dwt_write8bitoffsetreg(AON_ID, AON_CFG1_OFFSET, AON_CFG1_SLEEP_CEN); |
| 1930 |
_dwt_aonconfigupload(); |
| 1931 |
|
| 1932 |
// Put system PLL back on
|
| 1933 |
_dwt_enableclocks(ENABLE_ALL_SEQ); |
| 1934 |
} |
| 1935 |
|
| 1936 |
|
| 1937 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 1938 |
* @fn dwt_calibratesleepcnt()
|
| 1939 |
*
|
| 1940 |
* @brief calibrates the local oscillator as its frequency can vary between 7 and 13kHz depending on temp and voltage
|
| 1941 |
*
|
| 1942 |
* NOTE: this function needs to be run before dwt_configuresleepcnt, so that we know what the counter units are
|
| 1943 |
*
|
| 1944 |
* input parameters
|
| 1945 |
*
|
| 1946 |
* output parameters
|
| 1947 |
*
|
| 1948 |
* returns the number of XTAL/2 cycles per low-power oscillator cycle. LP OSC frequency = 19.2 MHz/return value
|
| 1949 |
*/
|
| 1950 |
uint16 dwt_calibratesleepcnt(void)
|
| 1951 |
{
|
| 1952 |
uint16 result; |
| 1953 |
|
| 1954 |
// Enable calibration of the sleep counter
|
| 1955 |
dwt_write8bitoffsetreg(AON_ID, AON_CFG1_OFFSET, AON_CFG1_LPOSC_CAL); |
| 1956 |
_dwt_aonconfigupload(); |
| 1957 |
|
| 1958 |
// Disable calibration of the sleep counter
|
| 1959 |
dwt_write8bitoffsetreg(AON_ID, AON_CFG1_OFFSET, 0x00);
|
| 1960 |
_dwt_aonconfigupload(); |
| 1961 |
|
| 1962 |
// Force system clock to crystal
|
| 1963 |
_dwt_enableclocks(FORCE_SYS_XTI); |
| 1964 |
|
| 1965 |
deca_sleep(1);
|
| 1966 |
|
| 1967 |
// Read the number of XTAL/2 cycles one LP oscillator cycle took.
|
| 1968 |
// Set up address - Read upper byte first
|
| 1969 |
dwt_write8bitoffsetreg(AON_ID, AON_ADDR_OFFSET, AON_ADDR_LPOSC_CAL_1); |
| 1970 |
|
| 1971 |
// Enable manual override
|
| 1972 |
dwt_write8bitoffsetreg(AON_ID, AON_CTRL_OFFSET, AON_CTRL_DCA_ENAB); |
| 1973 |
|
| 1974 |
// Read confirm data that was written
|
| 1975 |
dwt_write8bitoffsetreg(AON_ID, AON_CTRL_OFFSET, AON_CTRL_DCA_ENAB | AON_CTRL_DCA_READ); |
| 1976 |
|
| 1977 |
// Read back byte from AON
|
| 1978 |
result = dwt_read8bitoffsetreg(AON_ID, AON_RDAT_OFFSET); |
| 1979 |
result <<= 8;
|
| 1980 |
|
| 1981 |
// Set up address - Read lower byte
|
| 1982 |
dwt_write8bitoffsetreg(AON_ID, AON_ADDR_OFFSET, AON_ADDR_LPOSC_CAL_0); |
| 1983 |
|
| 1984 |
// Enable manual override
|
| 1985 |
dwt_write8bitoffsetreg(AON_ID, AON_CTRL_OFFSET, AON_CTRL_DCA_ENAB); |
| 1986 |
|
| 1987 |
// Read confirm data that was written
|
| 1988 |
dwt_write8bitoffsetreg(AON_ID, AON_CTRL_OFFSET, AON_CTRL_DCA_ENAB | AON_CTRL_DCA_READ); |
| 1989 |
|
| 1990 |
// Read back byte from AON
|
| 1991 |
result |= dwt_read8bitoffsetreg(AON_ID, AON_RDAT_OFFSET); |
| 1992 |
|
| 1993 |
// Disable manual override
|
| 1994 |
dwt_write8bitoffsetreg(AON_ID, AON_CTRL_OFFSET, 0x00);
|
| 1995 |
|
| 1996 |
// Put system PLL back on
|
| 1997 |
_dwt_enableclocks(ENABLE_ALL_SEQ); |
| 1998 |
|
| 1999 |
// Returns the number of XTAL/2 cycles per one LP OSC cycle
|
| 2000 |
// This can be converted into LP OSC frequency by 19.2 MHz/result
|
| 2001 |
return result;
|
| 2002 |
} |
| 2003 |
|
| 2004 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2005 |
* @fn dwt_configuresleep()
|
| 2006 |
*
|
| 2007 |
* @brief configures the device for both DEEP_SLEEP and SLEEP modes, and on-wake mode
|
| 2008 |
* i.e. before entering the sleep, the device should be programmed for TX or RX, then upon "waking up" the TX/RX settings
|
| 2009 |
* will be preserved and the device can immediately perform the desired action TX/RX
|
| 2010 |
*
|
| 2011 |
* NOTE: e.g. Tag operation - after deep sleep, the device needs to just load the TX buffer and send the frame
|
| 2012 |
*
|
| 2013 |
*
|
| 2014 |
* mode: the array and LDE code (OTP/ROM) and LDO tune, and set sleep persist
|
| 2015 |
* DWT_PRESRV_SLEEP 0x0100 - preserve sleep
|
| 2016 |
* DWT_LOADOPSET 0x0080 - load operating parameter set on wakeup
|
| 2017 |
* DWT_CONFIG 0x0040 - download the AON array into the HIF (configuration download)
|
| 2018 |
* DWT_LOADEUI 0x0008
|
| 2019 |
* DWT_GOTORX 0x0002
|
| 2020 |
* DWT_TANDV 0x0001
|
| 2021 |
*
|
| 2022 |
* wake: wake up parameters
|
| 2023 |
* DWT_XTAL_EN 0x10 - keep XTAL running during sleep
|
| 2024 |
* DWT_WAKE_SLPCNT 0x8 - wake up after sleep count
|
| 2025 |
* DWT_WAKE_CS 0x4 - wake up on chip select
|
| 2026 |
* DWT_WAKE_WK 0x2 - wake up on WAKEUP PIN
|
| 2027 |
* DWT_SLP_EN 0x1 - enable sleep/deep sleep functionality
|
| 2028 |
*
|
| 2029 |
* input parameters
|
| 2030 |
* @param mode - config on-wake parameters
|
| 2031 |
* @param wake - config wake up parameters
|
| 2032 |
*
|
| 2033 |
* output parameters
|
| 2034 |
*
|
| 2035 |
* no return value
|
| 2036 |
*/
|
| 2037 |
void dwt_configuresleep(uint16 mode, uint8 wake)
|
| 2038 |
{
|
| 2039 |
// Add predefined sleep settings before writing the mode
|
| 2040 |
mode |= pdw1000local->sleep_mode; |
| 2041 |
dwt_write16bitoffsetreg(AON_ID, AON_WCFG_OFFSET, mode); |
| 2042 |
|
| 2043 |
dwt_write8bitoffsetreg(AON_ID, AON_CFG0_OFFSET, wake); |
| 2044 |
} |
| 2045 |
|
| 2046 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2047 |
* @fn dwt_entersleepaftertx(int enable)
|
| 2048 |
*
|
| 2049 |
* @brief sets the auto TX to sleep bit. This means that after a frame
|
| 2050 |
* transmission the device will enter deep sleep mode. The dwt_configuresleep() function
|
| 2051 |
* needs to be called before this to configure the on-wake settings
|
| 2052 |
*
|
| 2053 |
* NOTE: the IRQ line has to be low/inactive (i.e. no pending events)
|
| 2054 |
*
|
| 2055 |
* input parameters
|
| 2056 |
* @param enable - 1 to configure the device to enter deep sleep after TX, 0 - disables the configuration
|
| 2057 |
*
|
| 2058 |
* output parameters
|
| 2059 |
*
|
| 2060 |
* no return value
|
| 2061 |
*/
|
| 2062 |
void dwt_entersleepaftertx(int enable) |
| 2063 |
{
|
| 2064 |
uint32 reg = dwt_read32bitoffsetreg(PMSC_ID, PMSC_CTRL1_OFFSET); |
| 2065 |
// Set the auto TX -> sleep bit
|
| 2066 |
if(enable)
|
| 2067 |
{
|
| 2068 |
reg |= PMSC_CTRL1_ATXSLP; |
| 2069 |
} |
| 2070 |
else
|
| 2071 |
{
|
| 2072 |
reg &= ~(PMSC_CTRL1_ATXSLP); |
| 2073 |
} |
| 2074 |
dwt_write32bitoffsetreg(PMSC_ID, PMSC_CTRL1_OFFSET, reg); |
| 2075 |
} |
| 2076 |
|
| 2077 |
|
| 2078 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2079 |
* @fn dwt_spicswakeup()
|
| 2080 |
*
|
| 2081 |
* @brief wake up the device from sleep mode using the SPI read,
|
| 2082 |
* the device will wake up on chip select line going low if the line is held low for at least 500us.
|
| 2083 |
* To define the length depending on the time one wants to hold
|
| 2084 |
* the chip select line low, use the following formula:
|
| 2085 |
*
|
| 2086 |
* length (bytes) = time (s) * byte_rate (Hz)
|
| 2087 |
*
|
| 2088 |
* where fastest byte_rate is spi_rate (Hz) / 8 if the SPI is sending the bytes back-to-back.
|
| 2089 |
* To save time and power, a system designer could determine byte_rate value more precisely.
|
| 2090 |
*
|
| 2091 |
* NOTE: Alternatively the device can be waken up with WAKE_UP pin if configured for that operation
|
| 2092 |
*
|
| 2093 |
* input parameters
|
| 2094 |
* @param buff - this is a pointer to the dummy buffer which will be used in the SPI read transaction used for the WAKE UP of the device
|
| 2095 |
* @param length - this is the length of the dummy buffer
|
| 2096 |
*
|
| 2097 |
* output parameters
|
| 2098 |
*
|
| 2099 |
* returns DWT_SUCCESS for success, or DWT_ERROR for error
|
| 2100 |
*/
|
| 2101 |
int dwt_spicswakeup(uint8 *buff, uint16 length)
|
| 2102 |
{
|
| 2103 |
if(dwt_readdevid() != DWT_DEVICE_ID) // Device was in deep sleep (the first read fails) |
| 2104 |
{
|
| 2105 |
// Need to keep chip select line low for at least 500us
|
| 2106 |
dwt_readfromdevice(0x0, 0x0, length, buff); // Do a long read to wake up the chip (hold the chip select low) |
| 2107 |
|
| 2108 |
// Need 5ms for XTAL to start and stabilise (could wait for PLL lock IRQ status bit !!!)
|
| 2109 |
// NOTE: Polling of the STATUS register is not possible unless frequency is < 3MHz
|
| 2110 |
deca_sleep(5);
|
| 2111 |
} |
| 2112 |
else
|
| 2113 |
{
|
| 2114 |
return DWT_SUCCESS;
|
| 2115 |
} |
| 2116 |
// DEBUG - check if still in sleep mode
|
| 2117 |
if(dwt_readdevid() != DWT_DEVICE_ID)
|
| 2118 |
{
|
| 2119 |
return DWT_ERROR;
|
| 2120 |
} |
| 2121 |
|
| 2122 |
return DWT_SUCCESS;
|
| 2123 |
} |
| 2124 |
|
| 2125 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2126 |
* @fn _dwt_configlde()
|
| 2127 |
*
|
| 2128 |
* @brief configure LDE algorithm parameters
|
| 2129 |
*
|
| 2130 |
* input parameters
|
| 2131 |
* @param prf - this is the PRF index (0 or 1) 0 corresponds to 16 and 1 to 64 PRF
|
| 2132 |
*
|
| 2133 |
* output parameters
|
| 2134 |
*
|
| 2135 |
* no return value
|
| 2136 |
*/
|
| 2137 |
void _dwt_configlde(int prfIndex) |
| 2138 |
{
|
| 2139 |
dwt_write8bitoffsetreg(LDE_IF_ID, LDE_CFG1_OFFSET, LDE_PARAM1); // 8-bit configuration register
|
| 2140 |
|
| 2141 |
if(prfIndex)
|
| 2142 |
{
|
| 2143 |
dwt_write16bitoffsetreg( LDE_IF_ID, LDE_CFG2_OFFSET, (uint16) LDE_PARAM3_64); // 16-bit LDE configuration tuning register
|
| 2144 |
} |
| 2145 |
else
|
| 2146 |
{
|
| 2147 |
dwt_write16bitoffsetreg( LDE_IF_ID, LDE_CFG2_OFFSET, (uint16) LDE_PARAM3_16); |
| 2148 |
} |
| 2149 |
} |
| 2150 |
|
| 2151 |
|
| 2152 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2153 |
* @fn _dwt_loaducodefromrom()
|
| 2154 |
*
|
| 2155 |
* @brief load ucode from OTP MEMORY or ROM
|
| 2156 |
*
|
| 2157 |
* input parameters
|
| 2158 |
*
|
| 2159 |
* output parameters
|
| 2160 |
*
|
| 2161 |
* no return value
|
| 2162 |
*/
|
| 2163 |
void _dwt_loaducodefromrom(void) |
| 2164 |
{
|
| 2165 |
// Set up clocks
|
| 2166 |
_dwt_enableclocks(FORCE_LDE); |
| 2167 |
|
| 2168 |
// Kick off the LDE load
|
| 2169 |
dwt_write16bitoffsetreg(OTP_IF_ID, OTP_CTRL, OTP_CTRL_LDELOAD); // Set load LDE kick bit
|
| 2170 |
|
| 2171 |
deca_sleep(1); // Allow time for code to upload (should take up to 120 us) |
| 2172 |
|
| 2173 |
// Default clocks (ENABLE_ALL_SEQ)
|
| 2174 |
_dwt_enableclocks(ENABLE_ALL_SEQ); // Enable clocks for sequencing
|
| 2175 |
} |
| 2176 |
|
| 2177 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2178 |
* @fn dwt_loadopsettabfromotp()
|
| 2179 |
*
|
| 2180 |
* @brief This is used to select which Operational Parameter Set table to load from OTP memory
|
| 2181 |
*
|
| 2182 |
* input parameters
|
| 2183 |
* @param ops_sel - Operational Parameter Set table to load:
|
| 2184 |
* DWT_OPSET_64LEN = 0x0 - load the operational parameter set table for 64 length preamble configuration
|
| 2185 |
* DWT_OPSET_TIGHT = 0x1 - load the operational parameter set table for tight xtal offsets (<1ppm)
|
| 2186 |
* DWT_OPSET_DEFLT = 0x2 - load the default operational parameter set table (this is loaded from reset)
|
| 2187 |
*
|
| 2188 |
* output parameters
|
| 2189 |
*
|
| 2190 |
* no return value
|
| 2191 |
*/
|
| 2192 |
void dwt_loadopsettabfromotp(uint8 ops_sel)
|
| 2193 |
{
|
| 2194 |
uint16 reg = ((ops_sel << OTP_SF_OPS_SEL_SHFT) & OTP_SF_OPS_SEL_MASK) | OTP_SF_OPS_KICK; // Select defined OPS table and trigger its loading
|
| 2195 |
|
| 2196 |
// Set up clocks
|
| 2197 |
_dwt_enableclocks(FORCE_LDE); |
| 2198 |
|
| 2199 |
dwt_write16bitoffsetreg(OTP_IF_ID, OTP_SF, reg); |
| 2200 |
|
| 2201 |
// Default clocks (ENABLE_ALL_SEQ)
|
| 2202 |
_dwt_enableclocks(ENABLE_ALL_SEQ); // Enable clocks for sequencing
|
| 2203 |
|
| 2204 |
} |
| 2205 |
|
| 2206 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2207 |
* @fn dwt_setsmarttxpower()
|
| 2208 |
*
|
| 2209 |
* @brief This call enables or disables the smart TX power feature.
|
| 2210 |
*
|
| 2211 |
* input parameters
|
| 2212 |
* @param enable - this enables or disables the TX smart power (1 = enable, 0 = disable)
|
| 2213 |
*
|
| 2214 |
* output parameters
|
| 2215 |
*
|
| 2216 |
* no return value
|
| 2217 |
*/
|
| 2218 |
void dwt_setsmarttxpower(int enable) |
| 2219 |
{
|
| 2220 |
// Config system register
|
| 2221 |
pdw1000local->sysCFGreg = dwt_read32bitreg(SYS_CFG_ID) ; // Read sysconfig register
|
| 2222 |
|
| 2223 |
// Disable smart power configuration
|
| 2224 |
if(enable)
|
| 2225 |
{
|
| 2226 |
pdw1000local->sysCFGreg &= ~(SYS_CFG_DIS_STXP) ; |
| 2227 |
} |
| 2228 |
else
|
| 2229 |
{
|
| 2230 |
pdw1000local->sysCFGreg |= SYS_CFG_DIS_STXP ; |
| 2231 |
} |
| 2232 |
|
| 2233 |
dwt_write32bitreg(SYS_CFG_ID,pdw1000local->sysCFGreg) ; |
| 2234 |
} |
| 2235 |
|
| 2236 |
|
| 2237 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2238 |
* @fn dwt_enableautoack()
|
| 2239 |
*
|
| 2240 |
* @brief This call enables the auto-ACK feature. If the responseDelayTime (parameter) is 0, the ACK will be sent a.s.a.p.
|
| 2241 |
* otherwise it will be sent with a programmed delay (in symbols), max is 255.
|
| 2242 |
* NOTE: needs to have frame filtering enabled as well
|
| 2243 |
*
|
| 2244 |
* input parameters
|
| 2245 |
* @param responseDelayTime - if non-zero the ACK is sent after this delay, max is 255.
|
| 2246 |
*
|
| 2247 |
* output parameters
|
| 2248 |
*
|
| 2249 |
* no return value
|
| 2250 |
*/
|
| 2251 |
void dwt_enableautoack(uint8 responseDelayTime)
|
| 2252 |
{
|
| 2253 |
// Set auto ACK reply delay
|
| 2254 |
dwt_write8bitoffsetreg(ACK_RESP_T_ID, ACK_RESP_T_ACK_TIM_OFFSET, responseDelayTime); // In symbols
|
| 2255 |
// Enable auto ACK
|
| 2256 |
pdw1000local->sysCFGreg |= SYS_CFG_AUTOACK; |
| 2257 |
dwt_write32bitreg(SYS_CFG_ID,pdw1000local->sysCFGreg) ; |
| 2258 |
} |
| 2259 |
|
| 2260 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2261 |
* @fn dwt_setdblrxbuffmode()
|
| 2262 |
*
|
| 2263 |
* @brief This call enables the double receive buffer mode
|
| 2264 |
*
|
| 2265 |
* input parameters
|
| 2266 |
* @param enable - 1 to enable, 0 to disable the double buffer mode
|
| 2267 |
*
|
| 2268 |
* output parameters
|
| 2269 |
*
|
| 2270 |
* no return value
|
| 2271 |
*/
|
| 2272 |
void dwt_setdblrxbuffmode(int enable) |
| 2273 |
{
|
| 2274 |
if(enable)
|
| 2275 |
{
|
| 2276 |
// Enable double RX buffer mode
|
| 2277 |
pdw1000local->sysCFGreg &= ~SYS_CFG_DIS_DRXB; |
| 2278 |
pdw1000local->dblbuffon = 1;
|
| 2279 |
} |
| 2280 |
else
|
| 2281 |
{
|
| 2282 |
// Disable double RX buffer mode
|
| 2283 |
pdw1000local->sysCFGreg |= SYS_CFG_DIS_DRXB; |
| 2284 |
pdw1000local->dblbuffon = 0;
|
| 2285 |
} |
| 2286 |
|
| 2287 |
dwt_write32bitreg(SYS_CFG_ID,pdw1000local->sysCFGreg) ; |
| 2288 |
} |
| 2289 |
|
| 2290 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2291 |
* @fn dwt_setrxaftertxdelay()
|
| 2292 |
*
|
| 2293 |
* @brief This sets the receiver turn on delay time after a transmission of a frame
|
| 2294 |
*
|
| 2295 |
* input parameters
|
| 2296 |
* @param rxDelayTime - (20 bits) - the delay is in UWB microseconds
|
| 2297 |
*
|
| 2298 |
* output parameters
|
| 2299 |
*
|
| 2300 |
* no return value
|
| 2301 |
*/
|
| 2302 |
void dwt_setrxaftertxdelay(uint32 rxDelayTime)
|
| 2303 |
{
|
| 2304 |
uint32 val = dwt_read32bitreg(ACK_RESP_T_ID) ; // Read ACK_RESP_T_ID register
|
| 2305 |
|
| 2306 |
val &= ~(ACK_RESP_T_W4R_TIM_MASK) ; // Clear the timer (19:0)
|
| 2307 |
|
| 2308 |
val |= (rxDelayTime & ACK_RESP_T_W4R_TIM_MASK) ; // In UWB microseconds (e.g. turn the receiver on 20uus after TX)
|
| 2309 |
|
| 2310 |
dwt_write32bitreg(ACK_RESP_T_ID, val) ; |
| 2311 |
} |
| 2312 |
|
| 2313 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2314 |
* @fn dwt_setcallbacks()
|
| 2315 |
*
|
| 2316 |
* @brief This function is used to register the different callbacks called when one of the corresponding event occurs.
|
| 2317 |
*
|
| 2318 |
* NOTE: Callbacks can be undefined (set to NULL). In this case, dwt_isr() will process the event as usual but the 'null'
|
| 2319 |
* callback will not be called.
|
| 2320 |
*
|
| 2321 |
* input parameters
|
| 2322 |
* @param cbTxDone - the pointer to the TX confirmation event callback function
|
| 2323 |
* @param cbRxOk - the pointer to the RX good frame event callback function
|
| 2324 |
* @param cbRxTo - the pointer to the RX timeout events callback function
|
| 2325 |
* @param cbRxErr - the pointer to the RX error events callback function
|
| 2326 |
*
|
| 2327 |
* output parameters
|
| 2328 |
*
|
| 2329 |
* no return value
|
| 2330 |
*/
|
| 2331 |
void dwt_setcallbacks(dwt_cb_t cbTxDone, dwt_cb_t cbRxOk, dwt_cb_t cbRxTo, dwt_cb_t cbRxErr)
|
| 2332 |
{
|
| 2333 |
pdw1000local->cbTxDone = cbTxDone; |
| 2334 |
pdw1000local->cbRxOk = cbRxOk; |
| 2335 |
pdw1000local->cbRxTo = cbRxTo; |
| 2336 |
pdw1000local->cbRxErr = cbRxErr; |
| 2337 |
} |
| 2338 |
|
| 2339 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2340 |
* @fn dwt_checkirq()
|
| 2341 |
*
|
| 2342 |
* @brief This function checks if the IRQ line is active - this is used instead of interrupt handler
|
| 2343 |
*
|
| 2344 |
* input parameters
|
| 2345 |
*
|
| 2346 |
* output parameters
|
| 2347 |
*
|
| 2348 |
* return value is 1 if the IRQS bit is set and 0 otherwise
|
| 2349 |
*/
|
| 2350 |
uint8 dwt_checkirq(void)
|
| 2351 |
{
|
| 2352 |
return (dwt_read8bitoffsetreg(SYS_STATUS_ID, SYS_STATUS_OFFSET) & SYS_STATUS_IRQS); // Reading the lower byte only is enough for this operation |
| 2353 |
} |
| 2354 |
|
| 2355 |
/*! ------------------------------------------------------------------------------------------------------------------
|
| 2356 |
* @fn dwt_isr()
|
| 2357 |
*
|
| 2358 |
* @brief This is the DW1000's general Interrupt Service Routine. It will process/report the following events:
|
| 2359 |
* - RXFCG (through cbRxOk callback)
|
| 2360 |
* - TXFRS (through cbTxDone callback)
|
| 2361 |
* - RXRFTO/RXPTO (through cbRxTo callback)
|
| 2362 |
* - RXPHE/RXFCE/RXRFSL/RXSFDTO/AFFREJ/LDEERR (through cbRxTo cbRxErr)
|
| 2363 |
* For all events, corresponding interrupts are cleared and necessary resets are performed. In addition, in the RXFCG case,
|
| 2364 |
* received frame information and frame control are read before calling the callback. If double buffering is activated, it
|
| 2365 |
* will also toggle between reception buffers once the reception callback processing has ended.
|
| 2366 |
*
|
| 2367 |
* /!\ This version of the ISR supports double buffering but does not support automatic RX re-enabling!
|
| 2368 |
*
|
| 2369 |
* NOTE: In PC based system using (Cheetah or ARM) USB to SPI converter there can be no interrupts, however we still need something
|
| 2370 |
* to take the place of it and operate in a polled way. In an embedded system this function should be configured to be triggered
|
| 2371 |
* on any of the interrupts described above.
|
| 2372 |
|
| 2373 |
* input parameters
|
| 2374 |
*
|
| 2375 |
* output parameters
|
| 2376 |
*
|
| 2377 |
* no return value
|
| 2378 |
*/
|
| 2379 |
void dwt_isr(void) |
| 2380 |
{
|
| 2381 |
uint32 status = pdw1000local->cbData.status = dwt_read32bitreg(SYS_STATUS_ID); // Read status register low 32bits
|
| 2382 |
|
| 2383 |
// Handle RX good frame event
|
| 2384 |
if(status & SYS_STATUS_RXFCG)
|
| 2385 |
{
|
| 2386 |
uint16 finfo16; |
| 2387 |
uint16 len; |
| 2388 |
|
| 2389 |
dwt_write32bitreg(SYS_STATUS_ID, SYS_STATUS_ALL_RX_GOOD); // Clear all receive status bits
|
| 2390 |
|
| 2391 |
pdw1000local->cbData.rx_flags = 0;
|
| 2392 |
|
| 2393 |
// Read frame info - Only the first two bytes of the register are used here.
|
| 2394 |
finfo16 = dwt_read16bitoffsetreg(RX_FINFO_ID, RX_FINFO_OFFSET); |
| 2395 |
|
| 2396 |
// Report frame length - Standard frame length up to 127, extended frame length up to 1023 bytes
|
| 2397 |
len = finfo16 & RX_FINFO_RXFL_MASK_1023; |
| 2398 |
if(pdw1000local->longFrames == 0) |
| 2399 |
{
|
| 2400 |
len &= RX_FINFO_RXFLEN_MASK; |
| 2401 |
} |
| 2402 |
pdw1000local->cbData.datalength = len; |
| 2403 |
|
| 2404 |
// Report ranging bit
|
| 2405 |
if(finfo16 & RX_FINFO_RNG)
|
| 2406 |
{
|
| 2407 |
pdw1000local->cbData.rx_flags |= DWT_CB_DATA_RX_FLAG_RNG; |
| 2408 |
} |
| 2409 |
|
| 2410 |
// Report frame control - First bytes of the received frame.
|
| 2411 |
dwt_readfromdevice(RX_BUFFER_ID, 0, FCTRL_LEN_MAX, pdw1000local->cbData.fctrl);
|
| 2412 |
|
| 2413 |
// Because of a previous frame not being received properly, AAT bit can be set upon the proper reception of a frame not requesting for
|