/******************************************************************************
*  Filename:       chipinfo.c
*  Revised:        2016-05-24 15:42:33 +0200 (Tue, 24 May 2016)
*  Revision:       46464
*
*  Description:    Collection of functions returning chip information.
*
*  Copyright (c) 2015 - 2016, Texas Instruments Incorporated
*  All rights reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions are met:
*
*  1) Redistributions of source code must retain the above copyright notice,
*     this list of conditions and the following disclaimer.
*
*  2) 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.
*
*  3) Neither the name of the ORGANIZATION 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.
*
******************************************************************************/

#include <driverlib/chipinfo.h>

//*****************************************************************************
//
// Handle support for DriverLib in ROM:
// This section will undo prototype renaming made in the header file
//
//*****************************************************************************
#if !defined(DOXYGEN)
    #undef  ChipInfo_GetSupportedProtocol_BV
    #define ChipInfo_GetSupportedProtocol_BV NOROM_ChipInfo_GetSupportedProtocol_BV
    #undef  ChipInfo_GetPackageType
    #define ChipInfo_GetPackageType         NOROM_ChipInfo_GetPackageType
    #undef  ChipInfo_GetChipType
    #define ChipInfo_GetChipType            NOROM_ChipInfo_GetChipType
    #undef  ChipInfo_GetChipFamily
    #define ChipInfo_GetChipFamily          NOROM_ChipInfo_GetChipFamily
    #undef  ChipInfo_GetHwRevision
    #define ChipInfo_GetHwRevision          NOROM_ChipInfo_GetHwRevision
    #undef  ThisCodeIsBuiltForCC26xxHwRev22AndLater_HaltIfViolated
    #define ThisCodeIsBuiltForCC26xxHwRev22AndLater_HaltIfViolated NOROM_ThisCodeIsBuiltForCC26xxHwRev22AndLater_HaltIfViolated
#endif

//*****************************************************************************
//
// ChipInfo_GetSupportedProtocol_BV()
//
//*****************************************************************************
ProtocolBitVector_t
ChipInfo_GetSupportedProtocol_BV( void )
{
   return ((ProtocolBitVector_t)( HWREG( PRCM_BASE + 0x1D4 ) & 0x0E ));
}


//*****************************************************************************
//
// ChipInfo_GetPackageType()
//
//*****************************************************************************
PackageType_t
ChipInfo_GetPackageType( void )
{
   PackageType_t packType = (PackageType_t)((
      HWREG( FCFG1_BASE + FCFG1_O_USER_ID     ) &
                          FCFG1_USER_ID_PKG_M ) >>
                          FCFG1_USER_ID_PKG_S ) ;

   if (( packType < PACKAGE_4x4  ) ||
       ( packType > PACKAGE_WCSP )    )
   {
      packType = PACKAGE_Unknown;
   }

   return ( packType );
}

//*****************************************************************************
//
// ChipInfo_GetChipFamily()
//
//*****************************************************************************
ChipFamily_t
ChipInfo_GetChipFamily( void )
{
   ChipFamily_t   chipFam  = FAMILY_Unknown  ;
   uint32_t       waferId                    ;

   waferId = (( HWREG( FCFG1_BASE + FCFG1_O_ICEPICK_DEVICE_ID ) &
                           FCFG1_ICEPICK_DEVICE_ID_WAFER_ID_M ) >>
                           FCFG1_ICEPICK_DEVICE_ID_WAFER_ID_S ) ;

   if ( waferId == 0xB99A ) {
      if ( ChipInfo_GetDeviceIdHwRevCode() == 0xB ) {
                                    chipFam = FAMILY_CC26xx_R2    ;
      } else {
                                    chipFam = FAMILY_CC26xx       ;
      }
   } else if ( waferId == 0xB9BE )  chipFam = FAMILY_CC13xx       ;
   else if (   waferId == 0xBB41 )  chipFam = FAMILY_CC26xx_Aga   ;
   else if (   waferId == 0xBB20 )  chipFam = FAMILY_CC26xx_Liz   ;

   return ( chipFam );
}


//*****************************************************************************
//
// ChipInfo_GetChipType()
//
//*****************************************************************************
ChipType_t
ChipInfo_GetChipType( void )
{
   ChipType_t chipType      = CHIP_TYPE_Unknown ;
   uint32_t   fcfg1UserId   = ChipInfo_GetUserId();
   uint32_t   fcfg1Protocol = (( fcfg1UserId & FCFG1_USER_ID_PROTOCOL_M ) >>
                                               FCFG1_USER_ID_PROTOCOL_S ) ;

   switch( ChipInfo_GetChipFamily() ) {

   case FAMILY_CC26xx :
      switch ( fcfg1Protocol ) {
      case 0x2 :
         chipType = CHIP_TYPE_CC2620 ;
         break;
      case 0x4 :
         chipType = CHIP_TYPE_CC2630 ;
      case 0x1 :
      case 0x9 :
         chipType = CHIP_TYPE_CC2640 ;
         if ( fcfg1UserId & ( 1 << 23 )) {
            chipType = CHIP_TYPE_CUSTOM_1;
         }
         break;
      case 0xF :
         chipType = CHIP_TYPE_CC2650 ;
         if ( fcfg1UserId & ( 1 << 24 )) {
            chipType = CHIP_TYPE_CUSTOM_0;
         }
         break;
      }
      break;

   default :
      chipType = CHIP_TYPE_Unknown ;
      break;
   }

   return ( chipType );
}


//*****************************************************************************
//
// ChipInfo_GetHwRevision()
//
//*****************************************************************************
HwRevision_t
ChipInfo_GetHwRevision( void )
{
   HwRevision_t   hwRev       = HWREV_Unknown                     ;
   uint32_t       fcfg1Rev    = ChipInfo_GetDeviceIdHwRevCode()   ;
   uint32_t       minorHwRev  = ChipInfo_GetMinorHwRev()          ;

   switch( ChipInfo_GetChipFamily() ) {
   case FAMILY_CC26xx :
      switch ( fcfg1Rev ) {
      case 1 : // CC26xx PG1.0
         hwRev = HWREV_1_0;
         break;
      case 3 : // CC26xx PG2.0
         hwRev = HWREV_2_0;
         break;
      case 7 : // CC26xx PG2.1
         hwRev = HWREV_2_1;
         break;
      case 8 : // CC26xx PG2.2 (or later)
         hwRev = (HwRevision_t)(((uint32_t)HWREV_2_2 ) + minorHwRev );
         break;
      }
      break;
   case FAMILY_CC13xx :
      switch ( fcfg1Rev ) {
      case 0 : // CC13xx PG1.0
         hwRev = HWREV_1_0;
         break;
      case 2 : // CC13xx PG2.0 (or later)
         hwRev = (HwRevision_t)(((uint32_t)HWREV_2_0 ) + minorHwRev );
         break;
      }
      break;
   case FAMILY_CC26xx_Liz :
   case FAMILY_CC26xx_Aga :
      switch ( fcfg1Rev ) {
      case 0 : // CC26xx_Liz or CC26xx_Aga PG1.0 (or later)
         hwRev = (HwRevision_t)(((uint32_t)HWREV_1_0 ) + minorHwRev );
         break;
      }
      break;
   case FAMILY_CC26xx_R2  :
      hwRev = (HwRevision_t)(((uint32_t)HWREV_1_0 ) + minorHwRev );
      break;
   default :
      // GCC gives warning if not handling all options explicitly in a "switch" on a variable of type "enum"
      break;
   }

   return ( hwRev );
}


//*****************************************************************************
// ThisCodeIsBuiltForCC26xxHwRev22AndLater_HaltIfViolated()
//*****************************************************************************
void
ThisCodeIsBuiltForCC26xxHwRev22AndLater_HaltIfViolated( void )
{
   if (( ! ChipInfo_ChipFamilyIsCC26xx()    ) ||
       ( ! ChipInfo_HwRevisionIs_GTEQ_2_2() )    )
   {
      while(1)
      {
         //
         // This driverlib version is for CC26xx PG2.2 and later
         // Do nothing - stay here forever
         //
      }
   }
}