xiaoxiang781216 commented on code in PR #6829: URL: https://github.com/apache/incubator-nuttx/pull/6829#discussion_r945047880
########## drivers/mtd/mtd_nvs.c: ########## @@ -0,0 +1,2244 @@ +/**************************************************************************** + * drivers/mtd/mtd_nvs.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * NVS: non volatile storage in flash + * + * Copyright (c) 2018 Laczen + * + * SPDX-License-Identifier: Apache-2.0 + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> +#include <sys/types.h> +#include <stdbool.h> +#include <stdio.h> +#include <string.h> +#include <crc8.h> +#include <debug.h> +#include <errno.h> +#include <sys/poll.h> +#include <nuttx/kmalloc.h> +#include <nuttx/mtd/mtd.h> +#include <nuttx/mtd/configdata.h> +#include "mtd_nvs.h" + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +#define CONFIG_MTD_NVS_WRITE_BLOCK_SIZE 4 +#define NVS_WRITE_BLOCK_SIZE CONFIG_MTD_NVS_WRITE_BLOCK_SIZE +#define MIN(a, b) ((a) > (b) ? (b) : (a)) + +/**************************************************************************** + * Private Types + ****************************************************************************/ + +/**************************************************************************** + * Private Function Prototypes + ****************************************************************************/ + +/* MTD NVS opeation api */ + +static int mtdnvs_open(FAR struct file *filep); +static int mtdnvs_close(FAR struct file *filep); +static ssize_t mtdnvs_read(FAR struct file *filep, FAR char *buffer, + size_t buflen); +static int mtdnvs_ioctl(FAR struct file *filep, int cmd, + unsigned long arg); +static int mtdnvs_poll(FAR struct file *filep, FAR struct pollfd *fds, + bool setup); + +/* Basic flash operation api */ + +static ssize_t flash_read(FAR struct mtd_dev_s *mtd, off_t offset, + FAR void *data, size_t len); +static ssize_t flash_write(FAR struct mtd_dev_s *mtd, off_t offset, + FAR const uint8_t *data, size_t len); +static int flash_erase(FAR struct mtd_dev_s *mtd, off_t offset, size_t len); + +/**************************************************************************** + * Private Data + ****************************************************************************/ + +static const struct file_operations mtdnvs_fops = +{ + mtdnvs_open, /* open */ + mtdnvs_close, /* close */ + mtdnvs_read, /* read */ + NULL, /* write */ + NULL, /* seek */ + mtdnvs_ioctl, /* ioctl */ + mtdnvs_poll /* poll */ +#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS + , NULL /* unlink */ +#endif +}; + +/**************************************************************************** + * Public Data + ****************************************************************************/ + +/**************************************************************************** + * Private Functions + ****************************************************************************/ + +static uint32_t fnv_32_str(FAR const char *str) Review Comment: fnv_hash_str ########## drivers/mtd/mtd_nvs.c: ########## @@ -0,0 +1,2244 @@ +/**************************************************************************** + * drivers/mtd/mtd_nvs.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * NVS: non volatile storage in flash + * + * Copyright (c) 2018 Laczen + * + * SPDX-License-Identifier: Apache-2.0 + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> +#include <sys/types.h> +#include <stdbool.h> +#include <stdio.h> +#include <string.h> +#include <crc8.h> +#include <debug.h> +#include <errno.h> +#include <sys/poll.h> +#include <nuttx/kmalloc.h> +#include <nuttx/mtd/mtd.h> +#include <nuttx/mtd/configdata.h> +#include "mtd_nvs.h" + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +#define CONFIG_MTD_NVS_WRITE_BLOCK_SIZE 4 +#define NVS_WRITE_BLOCK_SIZE CONFIG_MTD_NVS_WRITE_BLOCK_SIZE +#define MIN(a, b) ((a) > (b) ? (b) : (a)) + +/**************************************************************************** + * Private Types + ****************************************************************************/ + +/**************************************************************************** + * Private Function Prototypes + ****************************************************************************/ + +/* MTD NVS opeation api */ + +static int mtdnvs_open(FAR struct file *filep); +static int mtdnvs_close(FAR struct file *filep); +static ssize_t mtdnvs_read(FAR struct file *filep, FAR char *buffer, + size_t buflen); +static int mtdnvs_ioctl(FAR struct file *filep, int cmd, + unsigned long arg); +static int mtdnvs_poll(FAR struct file *filep, FAR struct pollfd *fds, + bool setup); + +/* Basic flash operation api */ + +static ssize_t flash_read(FAR struct mtd_dev_s *mtd, off_t offset, + FAR void *data, size_t len); +static ssize_t flash_write(FAR struct mtd_dev_s *mtd, off_t offset, + FAR const uint8_t *data, size_t len); +static int flash_erase(FAR struct mtd_dev_s *mtd, off_t offset, size_t len); + +/**************************************************************************** + * Private Data + ****************************************************************************/ + +static const struct file_operations mtdnvs_fops = +{ + mtdnvs_open, /* open */ + mtdnvs_close, /* close */ + mtdnvs_read, /* read */ + NULL, /* write */ + NULL, /* seek */ + mtdnvs_ioctl, /* ioctl */ + mtdnvs_poll /* poll */ +#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS + , NULL /* unlink */ +#endif +}; + +/**************************************************************************** + * Public Data + ****************************************************************************/ + +/**************************************************************************** + * Private Functions + ****************************************************************************/ + +static uint32_t fnv_32_str(FAR const char *str) +{ + FAR unsigned char *s = (FAR unsigned char *)str; + uint32_t hval = 2166136261; + + /* FNV-1 hash each octet in the buffer */ + + while (*s != 0) + { + /* multiply by the 32 bit FNV magic prime mod 2^32 */ + + hval *= 0x01000193; + + /* xor the bottom with the current octet */ + + hval ^= (uint32_t)*s++; + } + + return hval; +} + +#ifdef CONFIG_MTD_NVS_LOOKUP_CACHE Review Comment: where define this option? ########## drivers/mtd/mtd_nvs.c: ########## @@ -0,0 +1,2244 @@ +/**************************************************************************** + * drivers/mtd/mtd_nvs.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * NVS: non volatile storage in flash + * + * Copyright (c) 2018 Laczen + * + * SPDX-License-Identifier: Apache-2.0 + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> +#include <sys/types.h> +#include <stdbool.h> +#include <stdio.h> +#include <string.h> +#include <crc8.h> +#include <debug.h> +#include <errno.h> +#include <sys/poll.h> +#include <nuttx/kmalloc.h> +#include <nuttx/mtd/mtd.h> +#include <nuttx/mtd/configdata.h> +#include "mtd_nvs.h" + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +#define CONFIG_MTD_NVS_WRITE_BLOCK_SIZE 4 +#define NVS_WRITE_BLOCK_SIZE CONFIG_MTD_NVS_WRITE_BLOCK_SIZE +#define MIN(a, b) ((a) > (b) ? (b) : (a)) + +/**************************************************************************** + * Private Types + ****************************************************************************/ + +/**************************************************************************** + * Private Function Prototypes + ****************************************************************************/ + +/* MTD NVS opeation api */ + +static int mtdnvs_open(FAR struct file *filep); +static int mtdnvs_close(FAR struct file *filep); +static ssize_t mtdnvs_read(FAR struct file *filep, FAR char *buffer, + size_t buflen); +static int mtdnvs_ioctl(FAR struct file *filep, int cmd, + unsigned long arg); +static int mtdnvs_poll(FAR struct file *filep, FAR struct pollfd *fds, + bool setup); + +/* Basic flash operation api */ + +static ssize_t flash_read(FAR struct mtd_dev_s *mtd, off_t offset, + FAR void *data, size_t len); +static ssize_t flash_write(FAR struct mtd_dev_s *mtd, off_t offset, + FAR const uint8_t *data, size_t len); +static int flash_erase(FAR struct mtd_dev_s *mtd, off_t offset, size_t len); + +/**************************************************************************** + * Private Data + ****************************************************************************/ + +static const struct file_operations mtdnvs_fops = +{ + mtdnvs_open, /* open */ + mtdnvs_close, /* close */ + mtdnvs_read, /* read */ + NULL, /* write */ + NULL, /* seek */ + mtdnvs_ioctl, /* ioctl */ + mtdnvs_poll /* poll */ +#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS + , NULL /* unlink */ +#endif +}; + +/**************************************************************************** + * Public Data + ****************************************************************************/ + +/**************************************************************************** + * Private Functions + ****************************************************************************/ + +static uint32_t fnv_32_str(FAR const char *str) +{ + FAR unsigned char *s = (FAR unsigned char *)str; + uint32_t hval = 2166136261; + + /* FNV-1 hash each octet in the buffer */ + + while (*s != 0) + { + /* multiply by the 32 bit FNV magic prime mod 2^32 */ + + hval *= 0x01000193; + + /* xor the bottom with the current octet */ + + hval ^= (uint32_t)*s++; + } + + return hval; +} + +#ifdef CONFIG_MTD_NVS_LOOKUP_CACHE + +static inline size_t nvs_lookup_cache_pos(uint32_t id) +{ + size_t pos; + +#if CONFIG_NVS_LOOKUP_CACHE_SIZE <= UINT8_MAX + /* CRC8-CCITT is used for ATE checksums and it also acts well as a hash + * function, so it can be a good choice from the code size perspective. + * However, other hash functions can be used as well if proved better + * performance. + */ + + pos = crc8_ccitt(CRC8_CCITT_INITIAL_VALUE, &id, sizeof(id)); +#else + pos = crc16_ccitt(0xffff, (FAR const uint8_t *)&id, sizeof(id)); +#endif + + return pos % CONFIG_NVS_LOOKUP_CACHE_SIZE; +} + +static int nvs_lookup_cache_rebuild(FAR struct nvs_fs *fs) +{ + int rc; + uint32_t addr; + uint32_t ate_addr; + FAR uint32_t *cache_entry; + struct nvs_ate ate; + + memset(fs->lookup_cache, CONFIG_MTD_CONFIG_ERASEDVALUE, + sizeof(fs->lookup_cache)); + addr = fs->ate_wra; + + while (true) + { + /* Make a copy of 'addr' as it will be advanced by nvs_pref_ate() */ + + ate_addr = addr; + rc = nvs_prev_ate(fs, &addr, &ate); + + if (rc) + { + return rc; + } + + cache_entry = &fs->lookup_cache[nvs_lookup_cache_pos(ate.id)]; + + if (ate.id != 0xffffffff && *cache_entry == NVS_LOOKUP_CACHE_NO_ADDR && + nvs_ate_valid(fs, &ate)) + { + *cache_entry = ate_addr; + } + + if (addr == fs->ate_wra) + { + break; + } + } + + return 0; +} + +static void nvs_lookup_cache_invalidate(FAR struct nvs_fs *fs, + uint32_t sector) +{ + FAR uint32_t *cache_entry = fs->lookup_cache; + FAR uint32_t *const cache_end = + &fs->lookup_cache[CONFIG_NVS_LOOKUP_CACHE_SIZE]; + + for (; cache_entry < cache_end; ++cache_entry) + { + if ((*cache_entry >> ADDR_SECT_SHIFT) == sector) + { + *cache_entry = NVS_LOOKUP_CACHE_NO_ADDR; + } + } +} + +#endif /* CONFIG_MTD_NVS_LOOKUP_CACHE */ + +static ssize_t flash_read(FAR struct mtd_dev_s *mtd, off_t offset, + FAR void *data, size_t len) +{ + int ret; + ret = MTD_READ(mtd, offset, len, data); + if (ret < 0) + { + return ret; + } + + return OK; +} + +static ssize_t flash_write(FAR struct mtd_dev_s *mtd, off_t offset, + FAR const uint8_t *data, size_t len) +{ +#ifdef CONFIG_MTD_BYTE_WRITE + MTD_WRITE(mtd, offset, len, data); Review Comment: return error code -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
