How to build the Gecko Bootloader for variant EFR32 chips?

Background:

From the v6.1 EmberZnet stack and later, Silicon Labs didn't provide pre-build bootloader for EFR32 chip in stack. All the customers should build the Gecko Bootloader by themselves. This article is a guidance about how to build the Gecko Bootloader for variant EFR32 chips.

If custom would like to build the Gecko Bootloader for radio boards (eg, brd4151a/brd4162a). It is easy to do that, since we have lots of Gecko Bootloader samples in stack. Meanwhile, custom can choose the Board and Part Number for the bootloader sample, then generate the project and build it directly. Usually, there is no error happened in this case.

If custom would like to build the Gecko Bootloader for variant EFR32 chips, because there is no board can be chose for this chip, custom may meet some compiler errors when they build the bootloader. This article is talking about this case and hope it can help custom to create the Gecko Bootloader quickly.

Here are the details about how to build the Gecko Bootloader for variant EFR32 chips step by step.

Steps:

1. Please find the part number of your chip. For example, I build a Gecko Bootloader for EFR32MG1P232MG48.
2. Create a Gecko Bootloader sample for your chip.

   

3. Please decide which Gecko Bootloader you want to be built. Here are the different Bootloaders for different user cases. The a.i/a.ii are used for the external SPI flash (eg, MG1P/MG1B/MG1V). The a.iii/a.iv/a.v are used for internal main flash (eg, MG12/MG13). The b.i/b.ii are used for NCP.
   1. Application Bootloader(for SOC): 
      1. SPI Flash Storage Bootloaders(single image)
      2. SPI Flash Storage Bootloaders(multiple images)
      3. Internal Storage Bootloaders(single image on 1MB device)
      4. Internal Storage Bootloaders(single image on 512K device)
      5. Internal Storage Bootloaders(multiple images)
   2. NCP Bootloader(for NCP):
      1. UART XMODEM Bootloader
      2. EZSP SPI Bootloader
4. For example, I will build a SPI Flash Storage Bootloaders (single image) for EFR32MG1P232MG48.

   

5. Click “Next” and type the project name. Please note that I suppose there is no boards for this part number, so I only choose the right Part (EFR32MG1P232MG48) for the project.

   

6. Click “Finish”.
7. Generate the project.
8. Open the *.hwconf file. Double click the custom_efrmg1p232f256gm48.hwconf and broswer to “DefaultMode Peripherals”.

   

9. Configure the “CMU” module. If you don’t use the external 32.768k crystal on your board, please set the “False” for “LFXO present on board” under LFXO item. For HFXO, you can set the CTUNE value directly or through reading it from mfg token.

   

    
10. Configrure the “DCDC” module, you need enable this module if your board using the internal DCDC in EFR32 chip, otherwise disable it.

    

11. Configure the “SPI Flash” module. Set the “USART connected to SPI Flash” and GPIO for “Chip Select Pin”.

    

12. Configure the “USART1” module. Set the USART MOSI/MISO/CLK/CS pin for USART1.

    

13. Save the *.hwconfig file.
14. Build the project.
15. Download {ProjectName}-combined.s37 to your board.

In conclusion, it is not difficult to build the Gecko Bootloader for variant EFR32 chips base on the bootloader sample in stack. Due to there is no board can be chose, the key point is to configure the .hwconfig file for your project. If you meet any compile errors, please check the related modules in .hwconfig file. We are also recommended custom to create a Gecko Bootloader sample with Radio Boards (eg, brd4151a/brd4162a) for reference.  

在应用层中如何使用Token存储非易失性数据？

背景：

客户在开发应用程序时，经常需要存储一些非易失性数据，当设备复位或掉电之后数据依然保持不变。由于EM35x和EFR32MG芯片系列中没有内部EEPROM，EmberZnet使用部分内部Flash模拟EEPROM的功能来存储非易失性数据，比如网络参数信息、绑定表信息以及应用层存储非易失性数据等。在EmberZnet中，采用Token的方式对非易失性数据进行存储。

使用EmberZnet的Token来存储非易失性数据的方式可用于所需存储的非易失性数据不多（小于2KB或者小于8KB）的情形。而当需要存储大量的非易失性数据（数十KB甚至上百KB），就只能通过其它方式（增加外部EEPROM等）。

示例：

下面通过举例，介绍如何在应用层中使用应用层Token来存储非易失性数据。

1. 首先新建一个customer-token.h头文件，用来对使用的Token进行声明和定义。Token有三种类型BASIC/INDEX/COUNTER，区别请参考AN703文件。通常定义BASIC类型的Token即满足应用的需求。在定义Token时，customer-token.h头文件需要遵循一定的格式，请严格参考附件的格式。

   // APP CREATORS
   #define CREATOR_APP_VERSION_INFO            (0x8730)	//BASIC
   #define CREATOR_APP_SENSOR_NAME             (0x8731)	//BASIC
   #define CREATOR_APP_SENSOR_PARAMETERS       (0x8732)	//BASIC
   #define CREATOR_APP_EUI64_BACKUP            (0x8733)	//BASIC
   #define CREATOR_APP_INDEXED_ARRAY_DATA      (0x8734)	//INDEX
   #define CREATOR_APP_COUNTER                 (0x8735)	//COUNTER
   
   #if defined(DEFINETYPES)
   
   typedef uint16_t tokenTypeAppVersionInfo;
   typedef uint8_t tokenTypeSensorName[10];
   
   typedef struct {
        uint8_t initValues[5];
        uint8_t reportInterval;
        uint16_t calibrationValue;
   } tokenTypeSensorParameters;
   
   typedef uint8_t tokenTypeEUI64BackUp[8];
   typedef uint8_t tokenTypeArrayData[10];
   typedef uint32_t tokenTypeAppCounter;
   
   #endif //DEFINETYPES
   
   
   #ifdef DEFINETOKENS
   
   DEFINE_BASIC_TOKEN(APP_VERSION_INFO,
   					tokenTypeAppVersionInfo,
   					0x0000)
   DEFINE_BASIC_TOKEN(APP_SENSOR_NAME,
   					tokenTypeSensorName,
   					{'U','N','N','A','M','E','D',' ',' ',' '})
   DEFINE_BASIC_TOKEN(APP_SENSOR_PARAMETERS,
   					tokenTypeSensorParameters,
   					{{0x00,0x00,0x00,0x00,0x00},0x00,0x0000})
   DEFINE_BASIC_TOKEN(APP_EUI64_BACKUP,
   					tokenTypeEUI64BackUp,
   					{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00})
   DEFINE_INDEXED_TOKEN(APP_INDEXED_ARRAY_DATA,
   					tokenTypeArrayData,
   					10,
   					{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00})
   DEFINE_COUNTER_TOKEN(APP_COUNTER,
   					tokenTypeAppCounter,
   					0x00000000)
   
   #endif
   

   其主要内容包含3点：
   • 定义CREATORS
   • 定义DEFINETYPES
   • 定义DEFINETOKENS
2. Token定义完成之后，将customer-token.h拷贝到项目的根目录下。
3. 打开项目的.isc文件，在“Include”页面下的“Token Configuration”添加该头文件。
4. 保存.isc文件，并点击“Generate”重新生成项目文件。在弹出的对话框中选择覆盖“afv2-token.h”。
5. 编译项目，没有编译错误即可。
6. 之后在callback.c文件中可通过如下APIs来读/写token。

   // Write token
   	tokenTypeAppVersionInfo tokenVerInfo = 0x0101;
   	halCommonSetToken(TOKEN_APP_VERSION_INFO, &tokenVerInfo);
   
   // Read token
   	tokenTypeAppVersionInfo tokenVerInfo;
   	halCommonGetToken(&tokenVerInfo, TOKEN_APP_VERSION_INFO);
   	emberAfCorePrintln("Read TOKEN_APP_VERSION_INFO: version info: %x.\n", tokenVerInfo);

   针对不同的Token类型，使用的APIs也有所区别。
   • halCommonGetToken/ halCommonSetToken 读写 BASIC token.
   • halCommonGetIndexedToken/ halCommonSetIndexedToken读写INDEX token.
   • halCommonIncrementCounterToken写COUNTER token.

参考资料:

更多信息请参考下面文档：

An703 Using the Simulated EEPROM for the EM35x and Mighty Gecko SoC Platforms

UG103-7 Tokens Fundamentals

在应用层中如何使用Token存储非易失性数据？

背景：

客户在开发应用程序时，经常需要存储一些非易失性数据，当设备复位或掉电之后数据依然保持不变。由于EM35x和EFR32MG芯片系列中没有内部EEPROM，EmberZnet使用部分内部Flash模拟EEPROM的功能来存储非易失性数据，比如网络参数信息、绑定表信息以及应用层存储非易失性数据等。在EmberZnet中，采用Token的方式对非易失性数据进行存储。

使用EmberZnet的Token来存储非易失性数据的方式可用于所需存储的非易失性数据不多（小于2KB或者小于8KB）的情形。而当需要存储大量的非易失性数据（数十KB甚至上百KB），就只能通过其它方式（增加外部EEPROM等）。

示例：

下面通过举例，介绍如何在应用层中使用应用层Token来存储非易失性数据。

1. 首先新建一个customer-token.h头文件，用来对使用的Token进行声明和定义。Token有三种类型BASIC/INDEX/COUNTER，区别请参考AN703文件。通常定义BASIC类型的Token即满足应用的需求。在定义Token时，customer-token.h头文件需要遵循一定的格式，请严格参考附件的格式。

   // APP CREATORS
   #define CREATOR_APP_VERSION_INFO            (0x8730)	//BASIC
   #define CREATOR_APP_SENSOR_NAME             (0x8731)	//BASIC
   #define CREATOR_APP_SENSOR_PARAMETERS       (0x8732)	//BASIC
   #define CREATOR_APP_EUI64_BACKUP            (0x8733)	//BASIC
   #define CREATOR_APP_INDEXED_ARRAY_DATA      (0x8734)	//INDEX
   #define CREATOR_APP_COUNTER                 (0x8735)	//COUNTER
   
   #if defined(DEFINETYPES)
   
   typedef uint16_t tokenTypeAppVersionInfo;
   typedef uint8_t tokenTypeSensorName[10];
   
   typedef struct {
        uint8_t initValues[5];
        uint8_t reportInterval;
        uint16_t calibrationValue;
   } tokenTypeSensorParameters;
   
   typedef uint8_t tokenTypeEUI64BackUp[8];
   typedef uint8_t tokenTypeArrayData[10];
   typedef uint32_t tokenTypeAppCounter;
   
   #endif //DEFINETYPES
   
   
   #ifdef DEFINETOKENS
   
   DEFINE_BASIC_TOKEN(APP_VERSION_INFO,
   					tokenTypeAppVersionInfo,
   					0x0000)
   DEFINE_BASIC_TOKEN(APP_SENSOR_NAME,
   					tokenTypeSensorName,
   					{'U','N','N','A','M','E','D',' ',' ',' '})
   DEFINE_BASIC_TOKEN(APP_SENSOR_PARAMETERS,
   					tokenTypeSensorParameters,
   					{{0x00,0x00,0x00,0x00,0x00},0x00,0x0000})
   DEFINE_BASIC_TOKEN(APP_EUI64_BACKUP,
   					tokenTypeEUI64BackUp,
   					{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00})
   DEFINE_INDEXED_TOKEN(APP_INDEXED_ARRAY_DATA,
   					tokenTypeArrayData,
   					10,
   					{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00})
   DEFINE_COUNTER_TOKEN(APP_COUNTER,
   					tokenTypeAppCounter,
   					0x00000000)
   
   #endif
   

   其主要内容包含3点：
   • 定义CREATORS
   • 定义DEFINETYPES
   • 定义DEFINETOKENS
2. Token定义完成之后，将customer-token.h拷贝到项目的根目录下。
3. 打开项目的.isc文件，在“Include”页面下的“Token Configuration”添加该头文件。
4. 保存.isc文件，并点击“Generate”重新生成项目文件。在弹出的对话框中选择覆盖“afv2-token.h”。
5. 编译项目，没有编译错误即可。
6. 之后在callback.c文件中可通过如下APIs来读/写token。

   // Write token
   	tokenTypeAppVersionInfo tokenVerInfo = 0x0101;
   	halCommonSetToken(TOKEN_APP_VERSION_INFO, &tokenVerInfo);
   
   // Read token
   	tokenTypeAppVersionInfo tokenVerInfo;
   	halCommonGetToken(&tokenVerInfo, TOKEN_APP_VERSION_INFO);
   	emberAfCorePrintln("Read TOKEN_APP_VERSION_INFO: version info: %x.\n", tokenVerInfo);

   针对不同的Token类型，使用的APIs也有所区别。
   • halCommonGetToken/ halCommonSetToken 读取 BASIC token.
   • halCommonGetIndexedToken/ halCommonSetIndexedToken读取INDEX token.
   • halCommonIncrementCounterToken读取COUNTER token.

参考资料:

更多信息请参考下面文档：

An703 Using the Simulated EEPROM for the EM35x and Mighty Gecko SoC Platforms

UG103-7 Tokens Fundamentals

在应用层中如何使用Token存储非易失性数据？

背景：

客户在开发应用程序时，经常需要存储一些非易失性数据，当设备复位或掉电之后数据依然保持不变。由于EM35x和EFR32MG芯片系列中没有内部EEPROM，EmberZnet使用部分内部Flash模拟EEPROM的功能来存储非易失性数据，比如网络参数信息、绑定表信息以及应用层存储非易失性数据等。在EmberZnet中，采用Token的方式对非易失性数据进行存储。

使用EmberZnet的Token来存储非易失性数据的方式可用于所需存储的非易失性数据不多（小于2KB或者小于8KB）的情形。而当需要存储大量的非易失性数据（数十KB甚至上百KB），就只能通过其它方式（增加外部EEPROM等）。

示例：

下面通过举例，介绍如何在应用层中使用应用层Token来存储非易失性数据。

1. 首先新建一个customer-token.h头文件，用来对使用的Token进行声明和定义。Token有三种类型BASIC/INDEX/COUNTER，区别请参考AN703文件。通常定义BASIC类型的Token即满足应用的需求。在定义Token时，customer-token.h头文件需要遵循一定的格式，请严格参考附件的格式。

   // APP CREATORS
   #define CREATOR_APP_VERSION_INFO            (0x8730)	//BASIC
   #define CREATOR_APP_SENSOR_NAME             (0x8731)	//BASIC
   #define CREATOR_APP_SENSOR_PARAMETERS       (0x8732)	//BASIC
   #define CREATOR_APP_EUI64_BACKUP            (0x8733)	//BASIC
   #define CREATOR_APP_INDEXED_ARRAY_DATA      (0x8734)	//INDEX
   #define CREATOR_APP_COUNTER                 (0x8735)	//COUNTER
   
   #if defined(DEFINETYPES)
   
   typedef uint16_t tokenTypeAppVersionInfo;
   typedef uint8_t tokenTypeSensorName[10];
   
   typedef struct {
        uint8_t initValues[5];
        uint8_t reportInterval;
        uint16_t calibrationValue;
   } tokenTypeSensorParameters;
   
   typedef uint8_t tokenTypeEUI64BackUp[8];
   typedef uint8_t tokenTypeArrayData[10];
   typedef uint32_t tokenTypeAppCounter;
   
   #endif //DEFINETYPES
   
   
   #ifdef DEFINETOKENS
   
   DEFINE_BASIC_TOKEN(APP_VERSION_INFO,
   					tokenTypeAppVersionInfo,
   					0x0000)
   DEFINE_BASIC_TOKEN(APP_SENSOR_NAME,
   					tokenTypeSensorName,
   					{'U','N','N','A','M','E','D',' ',' ',' '})
   DEFINE_BASIC_TOKEN(APP_SENSOR_PARAMETERS,
   					tokenTypeSensorParameters,
   					{{0x00,0x00,0x00,0x00,0x00},0x00,0x0000})
   DEFINE_BASIC_TOKEN(APP_EUI64_BACKUP,
   					tokenTypeEUI64BackUp,
   					{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00})
   DEFINE_INDEXED_TOKEN(APP_INDEXED_ARRAY_DATA,
   					tokenTypeArrayData,
   					10,
   					{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00})
   DEFINE_COUNTER_TOKEN(APP_COUNTER,
   					tokenTypeAppCounter,
   					0x00000000)
   
   #endif
   

   其主要内容包含3点：
   • 定义CREATORS
   • 定义DEFINETYPES
   • 定义DEFINETOKENS
2. Token定义完成之后，将customer-token.h拷贝到项目的根目录下。
3. 打开项目的.isc文件，在“Include”页面下的“Token Configuration”添加该头文件。
4. 保存.isc文件，并点击“Generate”重新生成项目文件。在弹出的对话框中选择覆盖“afv2-token.h”。
5. 编译项目，没有编译错误即可。
6. 之后在callback.c文件中可通过如下APIs来读/写token。

   // Write token
   	tokenTypeAppVersionInfo tokenVerInfo = 0x0101;
   	halCommonSetToken(TOKEN_APP_VERSION_INFO, &tokenVerInfo);
   
   // Read token
   	tokenTypeAppVersionInfo tokenVerInfo;
   	halCommonGetToken(&tokenVerInfo, TOKEN_APP_VERSION_INFO);
   	emberAfCorePrintln("Read TOKEN_APP_VERSION_INFO: version info: %x.\n", tokenVerInfo);

   针对不同的Token类型，使用的APIs也有所区别。
   • halCommonGetToken/ halCommonSetToken 读取 BASIC token.
   • halCommonGetIndexedToken/ halCommonSetIndexedToken读取INDEX token.
   • halCommonIncrementCounterToken读取COUNTER token.

参考资料:

更多信息请参考下面文档：

An703 Using the Simulated EEPROM for the EM35x and Mighty Gecko SoC Platforms

UG103-7 Tokens Fundamentals

在应用层中如何使用Token存储非易失性数据？

背景：

客户在开发应用程序时，经常需要存储一些非易失性数据，当设备复位或掉电之后数据依然保持不变。由于EM35x和EFR32MG芯片系列中没有内部EEPROM，EmberZnet使用部分内部Flash模拟EEPROM的功能来存储非易失性数据，比如网络参数信息、绑定表信息以及应用层存储非易失性数据等。在EmberZnet中，采用Token的方式对非易失性数据进行存储。

使用EmberZnet的Token来存储非易失性数据的方式可用于所需存储的非易失性数据不多（小于2KB或者小于8KB）的情形。而当需要存储大量的非易失性数据（数十KB甚至上百KB），就只能通过其它方式（增加外部EEPROM等）。

示例：

下面通过举例，介绍如何在应用层中使用应用层Token来存储非易失性数据。

1. 首先新建一个customer-token.h头文件，用来对使用的Token进行声明和定义。Token有三种类型BASIC/INDEX/COUNTER，区别请参考AN703文件。通常定义BASIC类型的Token即满足应用的需求。在定义Token时，customer-token.h头文件需要遵循一定的格式，请严格参考附件的格式。

   // APP CREATORS
   #define CREATOR_APP_VERSION_INFO            (0x8730)	//BASIC
   #define CREATOR_APP_SENSOR_NAME             (0x8731)	//BASIC
   #define CREATOR_APP_SENSOR_PARAMETERS       (0x8732)	//BASIC
   #define CREATOR_APP_EUI64_BACKUP            (0x8733)	//BASIC
   #define CREATOR_APP_INDEXED_ARRAY_DATA      (0x8734)	//INDEX
   #define CREATOR_APP_COUNTER                 (0x8735)	//COUNTER
   
   #if defined(DEFINETYPES)
   
   typedef uint16_t tokenTypeAppVersionInfo;
   typedef uint8_t tokenTypeSensorName[10];
   
   typedef struct {
        uint8_t initValues[5];
        uint8_t reportInterval;
        uint16_t calibrationValue;
   } tokenTypeSensorParameters;
   
   typedef uint8_t tokenTypeEUI64BackUp[8];
   typedef uint8_t tokenTypeArrayData[10];
   typedef uint32_t tokenTypeAppCounter;
   
   #endif //DEFINETYPES
   
   
   #ifdef DEFINETOKENS
   
   DEFINE_BASIC_TOKEN(APP_VERSION_INFO,
   					tokenTypeAppVersionInfo,
   					0x0000)
   DEFINE_BASIC_TOKEN(APP_SENSOR_NAME,
   					tokenTypeSensorName,
   					{'U','N','N','A','M','E','D',' ',' ',' '})
   DEFINE_BASIC_TOKEN(APP_SENSOR_PARAMETERS,
   					tokenTypeSensorParameters,
   					{{0x00,0x00,0x00,0x00,0x00},0x00,0x0000})
   DEFINE_BASIC_TOKEN(APP_EUI64_BACKUP,
   					tokenTypeEUI64BackUp,
   					{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00})
   DEFINE_INDEXED_TOKEN(APP_INDEXED_ARRAY_DATA,
   					tokenTypeArrayData,
   					10,
   					{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00})
   DEFINE_COUNTER_TOKEN(APP_COUNTER,
   					tokenTypeAppCounter,
   					0x00000000)
   
   #endif
   

   其主要内容包含3点：
   • 定义CREATORS
   • 定义DEFINETYPES
   • 定义DEFINETOKENS
2. Token定义完成之后，将customer-token.h拷贝到项目的根目录下。
3. 打开项目的.isc文件，在“Include”页面下的“Token Configuration”添加该头文件。
4. 保存.isc文件，并点击“Generate”重新生成项目文件。在弹出的对话框中选择覆盖“afv2-token.h”。
5. 编译项目，没有编译错误即可。
6. 之后在callback.c文件中可通过如下APIs来读/写token。

   // Write token
   	tokenTypeAppVersionInfo tokenVerInfo = 0x0101;
   	halCommonSetToken(TOKEN_APP_VERSION_INFO, &tokenVerInfo);
   
   // Read token
   	tokenTypeAppVersionInfo tokenVerInfo;
   	halCommonGetToken(&tokenVerInfo, TOKEN_APP_VERSION_INFO);
   	emberAfCorePrintln("Read TOKEN_APP_VERSION_INFO: version info: %x.\n", tokenVerInfo);

   针对不同的Token类型，使用的APIs也有所区别。
   • halCommonGetToken/ halCommonSetToken 读取 BASIC token.
   • halCommonGetIndexedToken/ halCommonSetIndexedToken读取INDEX token.
   • halCommonIncrementCounterToken读取COUNTER token.

参考资料:

更多信息请参考下面文档：

An703 Using the Simulated EEPROM for the EM35x and Mighty Gecko SoC Platforms

UG103-7 Tokens Fundamentals

在应用层中如何使用Token存储非易失性数据？

背景：

客户在开发应用程序时，经常需要存储一些非易失性数据，当设备复位或掉电之后数据依然保持不变。由于EM35x和EFR32MG芯片系列中没有内部EEPROM，EmberZnet使用部分内部Flash模拟EEPROM的功能来存储非易失性数据，比如网络参数信息、绑定表信息以及应用层存储非易失性数据等。在EmberZnet中，采用Token的方式对非易失性数据进行存储。

使用EmberZnet的Token来存储非易失性数据的方式可用于所需存储的非易失性数据不多（小于2KB或者小于8KB）的情形。而当需要存储大量的非易失性数据（数十KB甚至上百KB），就只能通过其它方式（增加外部EEPROM等）。

示例：

下面通过举例，介绍如何在应用层中使用应用层Token来存储非易失性数据。

1. 首先新建一个customer-token.h头文件，用来对使用的Token进行声明和定义。Token有三种类型BASIC/INDEX/COUNTER，区别请参考AN703文件。通常定义BASIC类型的Token即满足应用的需求。在定义Token时，customer-token.h头文件需要遵循一定的格式，请严格参考附件的格式。

   
   
   // APP CREATORS
   #define CREATOR_APP_VERSION_INFO			(0x8730)	//BASIC
   #define CREATOR_APP_SENSOR_NAME				(0x8731)	//BASIC
   #define CREATOR_APP_SENSOR_PARAMETERS		(0x8732)	//BASIC
   #define CREATOR_APP_EUI64_BACKUP			(0x8733)  	//BASIC
   #define CREATOR_APP_INDEXED_ARRAY_DATA		(0x8734)	//INDEX
   #define CREATOR_APP_COUNTER					(0x8735)	//COUNTER
   
   #if defined(DEFINETYPES)
   
   typedef uint16_t tokenTypeAppVersionInfo;
   typedef uint8_t tokenTypeSensorName[10];
   
   typedef struct {
        uint8_t initValues[5];
        uint8_t reportInterval;
        uint16_t calibrationValue;
   } tokenTypeSensorParameters;
   
   typedef uint8_t tokenTypeEUI64BackUp[8];
   typedef uint8_t tokenTypeArrayData[10];
   typedef uint32_t tokenTypeAppCounter;
   
   #endif //DEFINETYPES
   
   
   #ifdef DEFINETOKENS
   
   DEFINE_BASIC_TOKEN(APP_VERSION_INFO,
   					tokenTypeAppVersionInfo,
   					0x0000)
   DEFINE_BASIC_TOKEN(APP_SENSOR_NAME,
   					tokenTypeSensorName,
   					{'U','N','N','A','M','E','D',' ',' ',' '})
   DEFINE_BASIC_TOKEN(APP_SENSOR_PARAMETERS,
   					tokenTypeSensorParameters,
   					{{0x00,0x00,0x00,0x00,0x00},0x00,0x0000})
   DEFINE_BASIC_TOKEN(APP_EUI64_BACKUP,
   					tokenTypeEUI64BackUp,
   					{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00})
   DEFINE_INDEXED_TOKEN(APP_INDEXED_ARRAY_DATA,
   					tokenTypeArrayData,
   					10,
   					{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00})
   DEFINE_COUNTER_TOKEN(APP_COUNTER,
   					tokenTypeAppCounter,
   					0x00000000)
   
   #endif
   

   其主要内容包含3点：
   • 定义CREATORS
   • 定义DEFINETYPES
   • 定义DEFINETOKENS
2. Token定义完成之后，将customer-token.h拷贝到项目的根目录下。
3. 打开项目的.isc文件，在“Include”页面下的“Token Configuration”添加该头文件。
4. 保存.isc文件，并点击“Generate”重新生成项目文件。在弹出的对话框中选择覆盖“afv2-token.h”。
5. 编译项目，没有编译错误即可。
6. 之后在callback.c文件中可通过如下APIs来读/写token。

   // Write token
   	tokenTypeAppVersionInfo tokenVerInfo = 0x0101;
   	halCommonSetToken(TOKEN_APP_VERSION_INFO, &tokenVerInfo);
   
   // Read token
   	tokenTypeAppVersionInfo tokenVerInfo;
   	halCommonGetToken(&tokenVerInfo, TOKEN_APP_VERSION_INFO);
   	emberAfCorePrintln("Read TOKEN_APP_VERSION_INFO: version info: %x.\n", tokenVerInfo);

   针对不同的Token类型，使用的APIs也有所区别。
   • halCommonGetToken/ halCommonSetToken 读取 BASIC token.
   • halCommonGetIndexedToken/ halCommonSetIndexedToken读取INDEX token.
   • halCommonIncrementCounterToken读取COUNTER token.

参考资料:

更多信息请参考下面文档：

An703 Using the Simulated EEPROM for the EM35x and Mighty Gecko SoC Platforms

UG103-7 Tokens Fundamentals

How to use custom application token in EmberZnet?

Background:

When customers develop their Zigbee application, most of them need to store nonvolatile data, so that these data can’t be lost after reset or power cycle. Because EM35x and Mighty Gecko process technology does not offer an internal EEPROM, a simulated EEPROM is implemented to use a section of internal flash memory for stack and application token storage. So customer can use custom application token to store these nonvolatile data. Here is example to help customers to use custom application token step by step.

Example:

1. Define your custom token in customer-token.h. There are three types of application tokens: BASIC/INDEX/COUNTER. Most of time, the BASIC token is enough for customers. Please refer to the attached customer-token.h.

   #define CREATOR_APP_VERSION_INFO			(0x8730)	//BASIC
   
   #if defined(DEFINETYPES)
   typedef uint16_t tokenTypeAppVersionInfo;
   #endif //DEFINETYPES
   
   #ifdef DEFINETOKENS
   DEFINE_BASIC_TOKEN(APP_VERSION_INFO,
   					tokenTypeAppVersionInfo,
   					0x0000)
   #endif
   

   1. Define the CREATORS
   2. Define the DEFINETYPES
   3. Define the DEFINETOKENS
2. Copy the customer-token.h to the project folder.
3. Open the {PROJECT}.isc file, click the “Include” tab and find the Token Configuration, then browser the customer-token.h to set the custom app token header. Save the {Project}.isc.
4. Generate the project and click OK to overwrite the afv2-token.h file.
5. Build your project.
6. Read/Write the custom application token in {Project}_callback.c.

   // Write token
   	tokenTypeAppVersionInfo tokenVerInfo = 0x0101;
   	halCommonSetToken(TOKEN_APP_VERSION_INFO, &tokenVerInfo);
   
   // Read token
   	tokenTypeAppVersionInfo tokenVerInfo;
   	halCommonGetToken(&tokenVerInfo, TOKEN_APP_VERSION_INFO);

   1. halCommonGetToken/ halCommonSetToken for BASIC token.
   2. halCommonGetIndexedToken/ halCommonSetIndexedToken for INDEX token.
   3. halCommonIncrementCounterToken for COUNTER token.
7. Please see attached callback.c for reference.

Reference:

For more information, please review the following documentation:

An703 Using the Simulated EEPROM for the EM35x and Mighty Gecko SoC Platforms

UG103-7 Tokens Fundamentals

How to use custom application token in EmberZnet?

Background:

When customers develop their Zigbee application, most of them need to store nonvolatile data, so that these data can’t be lost after reset or power cycle. Because EM35x and Mighty Gecko process technology does not offer an internal EEPROM, a simulated EEPROM is implemented to use a section of internal flash memory for stack and application token storage. So customer can use custom application token to store these nonvolatile data. Here is example to help customers to use custom application token step by step.

Example:

1. Define your custom token in customer-token.h. There are three types of application tokens: BASIC/INDEX/COUNTER. Most of time, the BASIC token is enough for customers. Please refer to the attached customer-token.h.
   1. Define the CREATORS
   2. Define the DEFINETYPES
   3. Define the DEFINETOKENS
2. Copy the customer-token.h to the project folder.
3. Open the {PROJECT}.isc file, click the “Include” tab and find the Token Configuration, then browser the customer-token.h to set the custom app token header. Save the {Project}.isc.
4. Generate the project and click OK to overwrite the afv2-token.h file.
5. Build your project.
6. Read/Write the custom application token in {Project}_callback.c.
   1. halCommonGetToken/ halCommonSetToken for BASIC token.
   2. halCommonGetIndexedToken/ halCommonSetIndexedToken for INDEX token.
   3. halCommonIncrementCounterToken for COUNTER token.
7. Please see attached callback.c for reference.

Reference:

For more information, please review the following documentation:

An703 Using the Simulated EEPROM for the EM35x and Mighty Gecko SoC Platforms

UG103-7 Tokens Fundamentals

How to use custom application token in EmberZnet?

Background:

When customers develop their Zigbee application, most of them need to store nonvolatile data, so that these data can’t be lost after reset or power cycle. Because EM35x and Mighty Gecko process technology does not offer an internal EEPROM, a simulated EEPROM is implemented to use a section of internal flash memory for stack and application token storage. So customer can use custom application token to store these nonvolatile data. Here is example to help customers to use custom application token step by step.

Example:

1. Define your custom token in customer-token.h. There are three types of application tokens: BASIC/INDEX/COUNTER. Most of time, the BASIC token is enough for customers. Please refer to the attached customer-token.h.
   1. Define the CREATORS
   2. Define the DEFINETYPES
   3. Define the DEFINETOKENS
2. Copy the customer-token.h to the project folder.
3. Open the {PROJECT}.isc file, click the “Include” tab and find the Token Configuration, then browser the customer-token.h to set the custom app token header. Save the {Project}.isc.
4. Generate the project and click OK to overwrite the afv2-token.h file.
5. Build your project.
6. Read/Write the custom application token in {Project}_callback.c.
   1. halCommonGetToken/ halCommonSetToken for BASIC token.
   2. halCommonGetIndexedToken/ halCommonSetIndexedToken for INDEX token.
   3. halCommonIncrementCounterToken for COUNTER token.
7. Please see attached callback.c for reference.

Reference:

For more information, please review the following documentation:

An703 Using the Simulated EEPROM for the EM35x and Mighty Gecko SoC Platforms

UG103-7 Tokens Fundamentals

How to use custom application token in EmberZnet?

Background:

When customers develop their Zigbee application, most of them need to store nonvolatile data, so that these data can’t be lost after reset or power cycle. Because EM35x and Mighty Gecko process technology does not offer an internal EEPROM, a simulated EEPROM is implemented to use a section of internal flash memory for stack and application token storage. So customer can use custom application token to store these nonvolatile data. Here is example to help customers to use custom application token step by step.

Example:

1. Define your custom token in customer-token.h. There are three types of application tokens: BASIC/INDEX/COUNTER. Most of time, the BASIC token is enough for customers. Please refer to the attached customer-token.h.
   1. Define the CREATORS
   2. Define the DEFINETYPES
   3. Define the DEFINETOKENS
2. Copy the customer-token.h to the project folder.
3. Open the {PROJECT}.isc file, click the “Include” tab and find the Token Configuration, then browser the customer-token.h to set the custom app token header. Save the {Project}.isc.

   1. 

4. Generate the project and click OK to overwrite the afv2-token.h file.
5. Build your project.
6. Read/Write the custom application token in {Project}_callback.c.
   1. halCommonGetToken/ halCommonSetToken for BASIC token.
   2. halCommonGetIndexedToken/ halCommonSetIndexedToken for INDEX token.
   3. halCommonIncrementCounterToken for COUNTER token.
7. Please see attached callback.c for reference.

Reference:

For more information, please review the following documentation:

An703 Using the Simulated EEPROM for the EM35x and Mighty Gecko SoC Platforms

UG103-7 Tokens Fundamentals