tlv.h

Go to the documentation of this file.

/* Copyright 2012-2014, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the software nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef BSP430_UTILITY_TLV_H
#define BSP430_UTILITY_TLV_H

#include <bsp430/core.h>

#ifndef configBSP430_TLV
#define configBSP430_TLV 0
#endif /* configBSP430_TLV */

#if defined(BSP430_DOXYGEN) || defined(configBSP430_TLV)
#define BSP430_TLV (configBSP430_TLV - 0)
#endif /* BSP430_TLV */

typedef struct sBSP430tlvEntry {
  unsigned char tag;
  unsigned char len;
} sBSP430tlvEntry;

typedef struct sBSP430tlvTable2xx {
  unsigned int crc;
  union {
    unsigned int words[1];
    sBSP430tlvEntry entry;
  };
} sBSP430tlvTable2xx;

typedef struct sBSP430tlvTable5xx {
  unsigned char info_len_lg2;
  unsigned char crc_len_lg2;
  unsigned int crc;
  unsigned int device_id;
  unsigned char firmware_revision;
  unsigned char hardware_revision;
  union {
    unsigned int words[1];
    sBSP430tlvEntry entry;
  };
} sBSP430tlvTable5xx;

#define BSP430_TLV_IS_5XX defined(__MSP430_HAS_MSP430XV2_CPU__)

#if defined(BSP430_DOXYGEN) || (BSP430_TLV_IS_5XX - 0)
typedef sBSP430tlvTable5xx sBSP430tlvTable;
#else /* BSP430_TLV_IS_5XX */
typedef sBSP430tlvTable2xx sBSP430tlvTable;
#endif /* BSP430_TLV_IS_5XX */

#define BSP430_TLV_NEXT_ENTRY(ep_) ((sBSP430tlvEntry *)(sizeof(sBSP430tlvEntry) + (ep_)->len + (unsigned char *)(ep_)))

#if defined(BSP430_DOXYGEN) || (BSP430_TLV_IS_5XX - 0)
#define BSP430_TLV_ENTRY_IS_ADC(ep_) ((TLV_ADC10CAL == (ep_)->tag) || (TLV_ADC12CAL == (ep_)->tag))
#else /* BSP430_TLV_IS_5XX */
#define BSP430_TLV_ENTRY_IS_ADC(ep_) ((TAG_DCO_30 != (ep_)->tag) && (TAG_EMPTY != (ep_)->tag))
#endif /* BSP430_TLV_IS_5XX */

#if defined(BSP430_DOXYGEN) || (BSP430_TLV_IS_5XX - 0)

/* Standard definitions when missing from header */
#ifndef TLV_LDTAG
#define TLV_LDTAG             (0x01)      
#endif /* TLV_LDTAG */
#ifndef TLV_PDTAG
#define TLV_PDTAG             (0x02)      
#endif /* TLV_PDTAG */
#ifndef TLV_BLANK
#define TLV_BLANK             (0x05)      
#endif /* TLV_BLANK */
#ifndef TLV_DIERECORD
#define TLV_DIERECORD         (0x08)      
#endif /* TLV_DIERECORD */
#ifndef TLV_ADC12CAL
#define TLV_ADC12CAL          (0x11)      
#endif /* TLV_ADC12CAL */
#ifndef TLV_REFCAL
#define TLV_REFCAL            (0x12)      
#endif /* TLV_REFCAL */
#ifndef TLV_ADC10CAL
#define TLV_ADC10CAL          (0x13)      
#endif /* TLV_ADC10CAL */
#ifndef TLV_TAGEXT
#define TLV_TAGEXT            (0xFE)      
#endif /* TLV_TAGEXT */

typedef struct sBSP430tlvDIERECORD {
  sBSP430tlvEntry hdr;          
  unsigned long lot_id;         
  unsigned int die_x_position;  
  unsigned int die_y_position;  
  unsigned int test_results;    
} sBSP430tlvDIERECORD;

typedef struct sBSP430tlvREFCAL {
  sBSP430tlvEntry hdr;          
  unsigned int cal_adc_15vref_factor; 
  unsigned int cal_adc_20vref_factor; 
  unsigned int cal_adc_25vref_factor; 
} sBSP430tlvREFCAL;

typedef struct sBPS430tlvADCCAL {
  sBSP430tlvEntry hdr;          
  unsigned int cal_adc_gain_factor; 
  unsigned int cal_adc_offset; 
  unsigned int cal_adc_15t30; 
  unsigned int cal_adc_15t85; 
  unsigned int cal_adc_20t30; 
  unsigned int cal_adc_20t85; 
  unsigned int cal_adc_25t30; 
  unsigned int cal_adc_25t85; 
} sBSP430tlvADCCAL;

#if 0
/* Documented in FR5XX user guide, but no examples available.  This
 * structure may need to be packed to correctly locate
 * bsl_cif_config. */
typedef struct sBSP430tlvBSL {
  sBSP430tlvEntry hdr;          
  unsigned char bsl_com_if;
  unsigned char bsl_cif_config[1];
} sBSP430tlvBSL;
#endif /* 0 */

#endif /* BSP430_TLV_IS_5XX */

#if defined(BSP430_DOXYGEN) || ! (BSP430_TLV_IS_5XX - 0)

/* Standard definitions when missing from header */
#ifndef TAG_DCO_30
#define TAG_DCO_30             (0x01)    
#endif /* TAG_DCO_30 */
#ifndef TAG_EMPTY
#define TAG_EMPTY              (0xFE)    
#endif /* TAG_EMPTY */

typedef struct sBSP430tlvDCO {
  sBSP430tlvEntry hdr;          
  unsigned char caldco_16MHz; 
  unsigned char calbc1_16MHz; 
  unsigned char caldco_12MHz; 
  unsigned char calbc1_12MHz; 
  unsigned char caldco_8MHz; 
  unsigned char calbc1_8MHz; 
  unsigned char caldco_1MHz; 
  unsigned char calbc1_1MHz; 
} sBSP430tlvDCO;

typedef struct sBPS430tlvADC {
  sBSP430tlvEntry hdr;          
  unsigned int cal_adc_gain_factor; 
  unsigned int cal_adc_offset; 
  unsigned int cal_adc_15vref_factor; 
  unsigned int cal_adc_15t30; 
  unsigned int cal_adc_15t85; 
  unsigned int cal_adc_25vref_factor; 
  unsigned int cal_adc_25t30; 
  unsigned int cal_adc_25t85; 
} sBSP430tlvADC;

#endif /* ! BSP430_TLV_IS_5XX */

#if defined(BSP430_DOXYGEN) || (BSP430_TLV_IS_5XX - 0)

#define BSP430_TLV_TABLE_DATA_OFFSET 4

#define BSP430_TLV_TABLE_PREFIX_LENGTH 8
#ifndef TLV_START

#define TLV_START (BSP430_TLV_TABLE_PREFIX_LENGTH + *(const unsigned int *)0x0FF4)

#define TLV_END (TLV_START - BSP430_TLV_TABLE_PREFIX_LENGTH + (4 << ((const sBSP430tlvTable *)BSP430_TLV_TABLE_START)->info_len_lg2) - 1)
#endif /* TLV_START */
#else /* BSP430_TLV_IS_5XX */
#define BSP430_TLV_TABLE_DATA_OFFSET 2
#define BSP430_TLV_TABLE_PREFIX_LENGTH 2
#define TLV_START 0x10C2
#define TLV_END 0x10FF
#endif /* BSP430_TLV_IS_5XX */

#define BSP430_TLV_TABLE_START ((const unsigned char *)TLV_START - BSP430_TLV_TABLE_PREFIX_LENGTH)

#define BSP430_TLV_TABLE_IS_VALID()                                     \
  (((const sBSP430tlvTable *)BSP430_TLV_TABLE_START)->crc               \
   == uiBSP430tlvChecksum(BSP430_TLV_TABLE_START + BSP430_TLV_TABLE_DATA_OFFSET, \
                          (1 + (const unsigned char *)TLV_END) - (BSP430_TLV_TABLE_START + BSP430_TLV_TABLE_DATA_OFFSET)))

unsigned int uiBSP430tlvChecksum (const unsigned char * data,
                                  size_t len);

#endif /* BSP430_UTILITY_TLV_H */