port.md 9.9 KB

EasyFlash ÒÆÖ²ËµÃ÷


1¡¢ÏÂÔØÔ´Âë

µã»÷´ËÁ´½Ó¼´¿ÉÖ±½ÓÏÂÔØÎ»ÓÚGithubÉϵÄ×îÐÂÔ´Âë¡£

½¨Ò飺µã»÷ÏîÄ¿Ö÷Ò³ https://github.com/armink/EasyFlash ÓÒÉÏ½Ç Watch & Star£¬ÕâÑùÏîÄ¿ÓиüÐÂʱ£¬»á¼°Ê±ÒÔÓʼþÐÎʽ֪ͨÄã¡£

Èç¹ûGithubÏÂÔØÌ«Âý£¬Ò²¿ÉÒÔµã»÷ÏîĿλÓڵĹúÄÚ²Ö¿âÏÂÔØµÄÁ´½Ó(OSChina|Coding)¡£

2¡¢µ¼ÈëÏîÄ¿

ÔÚµ¼Èëµ½ÏîĿǰ£¬ÏÈ´ò¿ª\demo\Îļþ¼Ð£¬¼ì²éÏÂÓÐûÓÐÓëÏîÄ¿Flash¹æ¸ñÒ»ÖµÄDemo¡£Èç¹ûÓÐÔòÏÈÖ±½ÓÌø¹ý2¡¢3¡¢4Õ½ڣ¬°´ÕÕµÚ5ÕµÄÒªÇóÉèÖòÎÊý£¬²¢ÔËÐС¢ÑéÖ¤Demo¡£Ñé֤ͨ¹ýÔÙ°´ÕÕÏÂÃæµÄµ¼ÈëÏîĿҪÇ󣬽«DemoÖеÄÒÆÖ²ÎļþÖ±½Óµ¼Èëµ½ÏîÄ¿Öм´¿É¡£

  • 1¡¢ÏȽâѹÏÂÔØºÃµÄÔ´Âë°ü£¬ÎļþµÄĿ¼½á¹¹´óÖÂÈçÏ£º
Ô´Îļþ ÃèÊö
\easyflash\src\ef_env.c Env£¨³£¹æÄ£Ê½£©Ïà¹Ø²Ù×÷½Ó¿Ú¼°ÊµÏÖÔ´Âë
\easyflash\src\ef_iap.c IAP Ïà¹Ø²Ù×÷½Ó¿Ú¼°ÊµÏÖÔ´Âë
\easyflash\src\ef_log.c Log Ïà¹Ø²Ù×÷½Ó¿Ú¼°ÊµÏÖÔ´Âë
\easyflash\src\ef_utils.c EasyFlash³£ÓÃС¹¤¾ß£¬ÀýÈ磺CRC32
\easyflash\src\easyflash.c Ŀǰֻ°üº¬EasyFlash³õʼ»¯·½·¨
\easyflash\port\ef_port.c ²»Í¬Æ½Ì¨ÏµÄEasyFlashÒÆÖ²½Ó¿Ú
\demo\env\stm32f10x\non_os stm32f10xÂã»úƬÄÚFlashµÄEnv demo
\demo\env\stm32f10x\non_os_spi_flash stm32f10xÂã»úSPI FlashµÄEnv demo
\demo\env\stm32f10x\rtt stm32f10x»ùÓÚRT-ThreadµÄƬÄÚFlash Env demo
\demo\env\stm32f4xx stm32f4xx»ùÓÚRT-ThreadµÄƬÄÚFlash Env demo
\demo\iap\ymodem+rtt.c ʹÓÃRT-Thread+YmodemµÄIAP Demo
\demo\log\easylogger.c »ùÓÚEasyLoggerµÄLog Demo
  • 2¡¢½«\easyflash\£¨ÀïÃæ°üº¬inc¡¢src¼°portµÄÄǸö£©Îļþ¼Ð¿½±´µ½ÏîÄ¿ÖУ»
  • 3¡¢Ìí¼Ó\easyflash\src\easyflash.c¡¢\easyflash\src\ef_utils.c¼°\easyflash\port\ef_port.cÕâЩÎļþµ½ÏîÄ¿µÄ±àÒë·¾¶ÖУ»
  • 4¡¢¸ù¾ÝÏîÄ¿ÐèÇó£¬Ñ¡ÔñÐÔÌí¼Ó\easyflash\src\ÖÐµÄÆäËûÔ´ÂëÎļþµ½ÏîÄ¿µÄ±àÒë·¾¶ÖУ»
  • 5¡¢Ìí¼Ó\easyflash\inc\Îļþ¼Ðµ½±àÒëµÄÍ·ÎļþĿ¼ÁбíÖУ»

3¡¢Flash¹æ¸ñ

ÔÚÒÆÖ²Ê±Îñ±ØÏÈÒªÁ˽âÏîÄ¿µÄFlash¹æ¸ñ£¬ÕâÀïÐèÒªÁ˽âÊǹæ¸ñÊÇ ²Á³ýÁ£¶È£¨²Á³ý×îСµ¥Ôª£© ¡¢Ð´ÈëÁ£¶È¼° ÄÚ²¿´æ´¢½á¹¹ £¬¸÷¸ö³§¼ÒµÄFlash¹æ¸ñ¶¼ÓвîÒ죬ͬһ³§¼Ò²»Í¬ÏµÁеĹæ¸ñÒ²ÓвîÒì¡£ÒÔÏÂÊÇһЩ³£¼û Flash µÄ¹æ¸ñ

Flash ÀàÐÍ Ð´ÈëÁ£¶È ²Á³ýÁ£¶È ÄÚ²¿´æ´¢½á¹¹
STM32F1 ƬÄÚ Flash 4bytes 1K/2K ¾ùÔÈ·Ö²¼
STM32F2/F4 ƬÄÚ Flash 1byte 16K/64K/128K ×î´óµÄÓÐ128K£¬×îСµÄÓÐ16K
Nor Flash£¨SPI-Flash£© 1bit 4K ¾ùÔÈ·Ö²¼

×¢Òâ £º

  • 1¡¢Îñ±Ø±£Ö¤ÊìϤFlash¹æ¸ñºó£¬ÔÙ¼ÌÐøÏÂÕ½ڣ»
  • 2¡¢V4.0 ÐÂģʽÔÝʱÎÞ·¨Ê¹ÓÃÔÚ STM32L4 ƬÄÚ Flash ÉÏ£¬L4 Ö»ÄÜʹÓà V3.0 °æ±¾»òÕß V4.0 µÄ EF_ENV_USING_LEGACY_MODE ģʽ

4¡¢ÒÆÖ²½Ó¿Ú

4.1 ÒÆÖ²³õʼ»¯

EasyFlashÒÆÖ²³õʼ»¯¡£¿ÉÒÔ´«µÝĬÈÏ»·¾³±äÁ¿£¬³õʼ»¯EasyFlashÒÆÖ²ËùÐèµÄ×ÊÔ´µÈµÈ¡£

EfErrCode ef_port_init(ef_env const **default_env, size_t *default_env_size)
²ÎÊý ÃèÊö
default_env ĬÈϵĻ·¾³±äÁ¿
default_env_size ĬÈÏ»·¾³±äÁ¿µÄÊýÁ¿

4.2 ¶ÁÈ¡Flash

×îСµ¥Î»Îª4¸ö×Ö½Ú¡£

EfErrCode ef_port_read(uint32_t addr, uint32_t *buf, size_t size)
²ÎÊý ÃèÊö
addr ¶ÁÈ¡ÆðʼµØÖ·£¨4×Ö½Ú¶ÔÆë£©
buf ´æ·Å¶ÁÈ¡Êý¾ÝµÄ»º³åÇø
size ¶ÁÈ¡Êý¾ÝµÄ´óС£¨×Ö½Ú£©

4.3 ²Á³ýFlash

EfErrCode ef_port_erase(uint32_t addr, size_t size)
²ÎÊý ÃèÊö
addr ²Á³ýÆðʼµØÖ·
size ²Á³ýÊý¾ÝµÄ´óС£¨×Ö½Ú£©

4.4 дÈëFlash

×îСµ¥Î»Îª4¸ö×Ö½Ú¡£

EfErrCode ef_port_write(uint32_t addr, const uint32_t *buf, size_t size)
²ÎÊý ÃèÊö
addr дÈëµÄÆðʼµØÖ·£¨4×Ö½Ú¶ÔÆë£©
buf Ô´Êý¾ÝµÄ»º³åÇø
size дÈëÊý¾ÝµÄ´óС£¨×Ö½Ú£©

4.5 ¶Ô»·¾³±äÁ¿»º³åÇø¼ÓËø

ΪÁ˱£Ö¤RAM»º³åÇøÔÚ²¢·¢Ö´ÐеݲȫÐÔ£¬ËùÒÔÐèÒª¶ÔÆä½øÐмÓËø£¨Èç¹ûÏîÄ¿µÄʹÓó¡¾°²»´æÔÚ²¢·¢Çé¿ö£¬Ôò¿ÉÒÔºöÂÔ£©¡£ÓвÙ×÷ϵͳʱ¿ÉÒÔʹÓûñÈ¡ÐźÅÁ¿À´¼ÓËø£¬Âã»úʱ¿ÉÒÔͨ¹ý¹Ø±ÕÈ«¾ÖÖжÏÀ´¼ÓËø¡£

void ef_port_env_lock(void)

4.6 ¶Ô»·¾³±äÁ¿»º³åÇø½âËø

ÓвÙ×÷ϵͳÊÇ¿ÉÒÔʹÓÃÊÍ·ÅÐźÅÁ¿À´½âËø£¬Âã»úʱ¿ÉÒÔͨ¹ý¿ªÆôÈ«¾ÖÖжÏÀ´½âËø¡£

void ef_port_env_unlock(void)

4.7 ´òÓ¡µ÷ÊÔÈÕÖ¾ÐÅÏ¢

ÔÚ¶¨ÒåPRINT_DEBUGºêºó£¬´òÓ¡µ÷ÊÔÈÕÖ¾ÐÅÏ¢¡£

void ef_log_debug(const char *file, const long line, const char *format, ...)
²ÎÊý ÃèÊö
file µ÷Óø÷½·¨µÄÎļþ
line µ÷Óø÷½·¨µÄÐкÅ
format ´òÓ¡¸ñʽ
... ²»¶¨²Î

4.8 ´òÓ¡ÆÕͨÈÕÖ¾ÐÅÏ¢

void ef_log_info(const char *format, ...)
²ÎÊý ÃèÊö
format ´òÓ¡¸ñʽ
... ²»¶¨²Î

4.9 ÎÞ¸ñʽ´òÓ¡ÐÅÏ¢

¸Ã·½·¨Êä³öÎ޹̶¨¸ñʽµÄ´òÓ¡ÐÅÏ¢£¬Îªef_print_env·½·¨ËùÓã¨Èç¹û²»Ê¹ÓÃef_print_envÔò¿ÉÒÔºöÂÔ£©¡£¶øef_log_debug¼°ef_log_info¿ÉÒÔÊä³ö´øÖ¸¶¨Ç°×º¼°¸ñʽµÄ´òÓ¡ÈÕÖ¾ÐÅÏ¢¡£

void ef_print(const char *format, ...)
²ÎÊý ÃèÊö
format ´òÓ¡¸ñʽ
... ²»¶¨²Î

4.10 ĬÈÏ»·¾³±äÁ¿¼¯ºÏ

ÔÚ ef_port.c Îļþ¶¥²¿¶¨ÒåÓÐ static const ef_env default_env_set[] £¬ÎÒÃÇ¿ÉÒÔ½«²úÆ·ÉÏÐèÒªµÄĬÈÏ»·¾³±äÁ¿¼¯Öж¨ÒåÔÚÕâÀï¡£µ± flash µÚÒ»´Î³õʼ»¯Ê±»á½«Ä¬ÈϵĻ·¾³±äÁ¿Ð´Èë¡£

ĬÈÏ»·¾³±äÁ¿ÄÚ²¿²ÉÓà void * ÀàÐÍ£¬ËùÒÔÖ§³ÖÈÎÒâÀàÐÍ£¬¿É²Î¿¼ÈçÏÂʾÀý£º

static uint32_t boot_count = 0;
static time_t boot_time[10] = {0, 1, 2, 3};
static const ef_env default_env_set[] = {
//      {   key  , value, value_len }£¬
        {"username", "armink", 0},   //ÀàÐÍΪ×Ö·û´®µÄ»·¾³±äÁ¿¿ÉÒÔÉ趨ֵµÄ³¤¶ÈΪ 0 £¬´Ëʱ»áÔÚ³õʼ»¯Ê±»á×Ô¶¯¼ì²âÆä³¤¶È
        {"password", "123456", 0},
        {"boot_count", &boot_count, sizeof(boot_count)},  //ÕûÐÎ
        {"boot_time", &boot_time, sizeof(boot_time)},  //Êý×éÀàÐÍ£¬ÆäËûÀàÐÍʹÓ÷½Ê½ÀàËÆ
};

5¡¢ÉèÖòÎÊý

ÅäÖÃʱÐèÒªÐÞ¸ÄÏîÄ¿ÖеÄef_cfg.hÎļþ£¬¿ªÆô¡¢¹Ø±Õ¡¢Ð޸ĶÔÓ¦µÄºê¼´¿É¡£

5.1 »·¾³±äÁ¿¹¦ÄÜ

  • ĬÈÏ״̬£º¿ªÆô
  • ²Ù×÷·½·¨£º¿ªÆô¡¢¹Ø±ÕEF_USING_ENVºê¼´¿É

5.1.1 ×Ô¶¯¸üУ¨ÔöÁ¿¸üУ©

¿ÉÒÔ¶Ô ENV ÉèÖð汾ºÅ£¨²ÎÕÕ 5.1.2£©¡£µ± ENV ³õʼ»¯Ê±£¬Èç¹û¼ì²âµ½²úÆ·´æ´¢µÄ°æ±¾ºÅÓëÉ趨°æ±¾ºÅ²»Ò»Ö£¬»á×Ô¶¯×·¼ÓĬÈÏ»·¾³±äÁ¿¼¯ºÏÖÐÐÂÔöµÄ»·¾³±äÁ¿¡£

¸Ã¹¦Äܷdz£ÊÊÓÃÓÚ¾­³£Éý¼¶µÄ²úÆ·ÖУ¬µ±²úÆ·¹¦Äܱä¸üʱ£¬ÓпÉÄÜ»áÐÂÔö»·¾³±äÁ¿£¬´ËʱֻÐèÒªÔö´óµ±Ç°É趨µÄ ENV °æ±¾ºÅ£¬Ï´ι̼þÉý¼¶ºó£¬ÐÂÔöµÄ»·¾³±äÁ¿½«»á×Ô¶¯×·¼ÓÉÏÈ¥¡£

  • ĬÈÏ״̬£º¹Ø±Õ
  • ²Ù×÷·½·¨£º¿ªÆô¡¢¹Ø±ÕEF_ENV_AUTO_UPDATEºê¼´¿É

5.1.2 »·¾³±äÁ¿°æ±¾ºÅ

¸ÃÅäÖÃÒÀÀµÓÚ 5.1.1 ÅäÖá£ÉèÖõĻ·¾³±äÁ¿°æ±¾ºÅΪÕûÐÎÊýÖµ£¬¿ÉÒÔ´Ó 0 ¿ªÊ¼¡£Èç¹ûÔÚĬÈÏ»·¾³±äÁ¿±íÖÐÔö¼ÓÁË»·¾³±äÁ¿£¬´ËʱÐèÒª¶Ô¸ÃÅäÖýøÐÐÐ޸ģ¨Í¨³£¼Ó 1 £©¡£

  • ²Ù×÷·½·¨£ºÐÞ¸ÄEF_ENV_VER_NUMºê¶ÔÓ¦Öµ¼´¿É

5.2 ÔÚÏßÉý¼¶¹¦ÄÜ

  • ĬÈÏ״̬£º¿ªÆô
  • ²Ù×÷·½·¨£º¿ªÆô¡¢¹Ø±ÕEF_USING_IAPºê¼´¿É

5.3 ÈÕÖ¾¹¦ÄÜ

  • ĬÈÏ״̬£º¿ªÆô
  • ²Ù×÷·½·¨£º¿ªÆô¡¢¹Ø±ÕEF_USING_LOGºê¼´¿É

5.4 Flash ²Á³ýÁ£¶È£¨×îС²Á³ýµ¥Î»£©

  • ²Ù×÷·½·¨£ºÐÞ¸ÄEF_ERASE_MIN_SIZEºê¶ÔÓ¦Öµ¼´¿É£¬µ¥Î»£ºbyte

5.5 Flash дÈëÁ£¶È

  • ²Ù×÷·½·¨£ºÐÞ¸ÄEF_WRITE_GRANºê¶ÔÓ¦Öµ¼´¿É£¬µ¥Î»£ºbit£¬½öÖ§³Ö£º1/8/32

5.5 ±¸·ÝÇø

±¸·ÝÇø¹²¼Æ°üº¬3¸öÇøÓò£¬ÒÀ´ÎΪ£º»·¾³±äÁ¿Çø¡¢ÈÕÖ¾Çø¼°ÔÚÏßÉý¼¶Çø¡£·ÖÇø·½Ê½ÈçÏÂͼËùʾ

backup_area_partiton

ÔÚÅäÖÃʱÐèҪעÒâÒÔϼ¸µã£º

  • 1¡¢ËùÓеÄÇøÓò±ØÐë°´ÕÕEF_ERASE_MIN_SIZE¶ÔÆë£»
  • 2¡¢»·¾³±äÁ¿·ÖÇø´óÉÙÖÁÉÙΪÁ½±¶ÒÔÉÏ EF_ERASE_MIN_SIZE£»
  • 3¡¢´Ó V4.0 ¿ªÊ¼ ENV µÄģʽÃüÃûΪ NG ģʽ£¬V4.0 ֮ǰµÄ³ÆÖ®Îª LEGACY ÒÅÁôģʽ£»
    • ÒÅÁôģʽÒѾ­±»·ÏÆú£¬²»ÔÙ½¨Òé¼ÌÐøÊ¹Óã»
    • Èç¹ûÐèÒª¼ÌÐøÊ¹ÓÃÒÅÁôģʽ£¬Çë EasyFlash µÄ V3.X °æ±¾¡£

5.5.1 ±¸·ÝÇøÆðʼµØÖ·

  • ²Ù×÷·½·¨£ºÐÞ¸ÄEF_START_ADDRºê¶ÔÓ¦Öµ¼´¿É

5.5.2 »·¾³±äÁ¿Çø×ÜÈÝÁ¿

  • ²Ù×÷·½·¨£ºÐÞ¸ÄENV_AREA_SIZEºê¶ÔÓ¦Öµ¼´¿É

×¢Ò⣺²»Ê¹Óû·¾³±äÁ¿¹¦ÄÜʱ£¬¿ÉÒÔ²»¶¨Òå´Ëºê¡£

5.5.3 ÈÕÖ¾Çø×ÜÈÝÁ¿

  • ²Ù×÷·½·¨£ºÐÞ¸ÄLOG_AREA_SIZEºê¶ÔÓ¦Öµ¼´¿É

×¢Ò⣺²»Ê¹ÓÃÈÕÖ¾¹¦ÄÜʱ£¬¿ÉÒÔ²»¶¨Òå´Ëºê¡£

5.6 µ÷ÊÔÈÕÖ¾

¿ªÆôºó£¬½«»á¿âÔËÐÐʱ×Ô¶¯Êä³öµ÷ÊÔÈÕÖ¾

  • ĬÈÏ״̬£º¿ªÆô
  • ²Ù×÷·½·¨£º¿ªÆô¡¢¹Ø±ÕPRINT_DEBUGºê¼´¿É

6¡¢²âÊÔÑéÖ¤

Èç¹û\demo\Îļþ¼ÐÏÂÓÐÓëÏîÄ¿Flash¹æ¸ñÒ»ÖµÄDemo£¬ÔòÖ±½Ó±àÒëÔËÐУ¬¹Û²ì²âÊÔ½á¹û¼´¿É¡£ÎÞÐè¹Ø×¢ÏÂÃæµÄ²½Öè¡£

ÿ´ÎʹÓÃǰ£¬Îñ±ØÏÈÖ´ÐÐeasyflash_init()·½·¨¶ÔEasyFlash¿â¼°ËùʹÓõÄFlash½øÐгõʼ»¯£¬±£Ö¤³õʼ»¯Ã»ÎÊÌâºó£¬ÔÙʹÓø÷¹¦ÄܵÄAPI·½·¨¡£Èç¹û³öÏÖ´íÎó»ò¶ÏÑÔ£¬Ðè¸ù¾ÝÌáʾÐÅÏ¢¼ì²éÒÆÖ²ÅäÖü°½Ó¿Ú¡£

6.1 »·¾³±äÁ¿

²é¿´\demo\env\×ÓÎļþ¼ÐÖÐÀý×ÓµÄREADME.md˵Ã÷Îĵµ¡£²âÊÔʱ¿ÉÒÔ½«\demo\env\stm32f10x\non_os\app\src\app.cÖеÄstatic void test_env(void)·½·¨Ì叴֯µ½ÏîÄ¿ÖУ¬È»ºóÔËÐвâÊÔ¡£

6.2 ÔÚÏßÉý¼¶

²é¿´\demo\iap\README.md˵Ã÷Îĵµ¡£

6.3 ÈÕÖ¾

²é¿´\demo\log\README.md˵Ã÷Îĵµ¡£

×¢Ò⣺easylogger.cÊÇʹÓÃEasyLoggerÓëEasyFlashµÄÎÞ·ì½Ó¿ÚµÄÀý×Ó£¬EasyLoggerÌṩÕë¶ÔÈÕÖ¾µÄºÜ¶à³£Óù¦ÄÜ·â×°£¬Ïêϸ¹¦ÄÜ¿ÉÒԲ鿴Æä½éÉÜ¡£Ê¹ÓÃÕâ¸öÀý×Óʱ£¬Îñ±Ø¼ÇµÃ½«EasyLoggerÒ»²¢µ¼Èëµ½ÏîÄ¿ÖС£