1 /* 2 * This file is part of the MicroPython project, http://micropython.org/ 3 * 4 * The MIT License (MIT) 5 * 6 * Copyright (c) 2013, 2014 Damien P. George 7 * 8 * Permission is hereby granted, free of charge, to any person obtaining a copy 9 * of this software and associated documentation files (the "Software"), to deal 10 * in the Software without restriction, including without limitation the rights 11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 12 * copies of the Software, and to permit persons to whom the Software is 13 * furnished to do so, subject to the following conditions: 14 * 15 * The above copyright notice and this permission notice shall be included in 16 * all copies or substantial portions of the Software. 17 * 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 24 * THE SOFTWARE. 25 */ 26 #ifndef MICROPY_INCLUDED_STM32_STORAGE_H 27 #define MICROPY_INCLUDED_STM32_STORAGE_H 28 29 #include "drivers/memory/spiflash.h" 30 31 #define FLASH_BLOCK_SIZE (512) 32 #define FLASH_PART1_START_BLOCK (0x100) 33 34 // Try to match Python-level VFS block protocol where possible for these constants 35 enum { 36 BDEV_IOCTL_INIT = 1, 37 BDEV_IOCTL_SYNC = 3, 38 BDEV_IOCTL_NUM_BLOCKS = 4, // units are FLASH_BLOCK_SIZE 39 BDEV_IOCTL_IRQ_HANDLER = 7, 40 }; 41 42 void storage_init(void); 43 uint32_t storage_get_block_size(void); 44 uint32_t storage_get_block_count(void); 45 void storage_flush(void); 46 bool storage_read_block(uint8_t *dest, uint32_t block); 47 bool storage_write_block(const uint8_t *src, uint32_t block); 48 49 // these return 0 on success, negative errno on error 50 int storage_read_blocks(uint8_t *dest, uint32_t block_num, uint32_t num_blocks); 51 int storage_write_blocks(const uint8_t *src, uint32_t block_num, uint32_t num_blocks); 52 int storage_readblocks_ext(uint8_t *dest, uint32_t block, uint32_t offset, uint32_t len); 53 54 int32_t flash_bdev_ioctl(uint32_t op, uint32_t arg); 55 bool flash_bdev_readblock(uint8_t *dest, uint32_t block); 56 bool flash_bdev_writeblock(const uint8_t *src, uint32_t block); 57 int flash_bdev_readblocks_ext(uint8_t *dest, uint32_t block, uint32_t offset, uint32_t len); 58 int flash_bdev_writeblocks_ext(const uint8_t *src, uint32_t block, uint32_t offset, uint32_t len); 59 60 typedef struct _spi_bdev_t { 61 mp_spiflash_t spiflash; 62 uint32_t flash_tick_counter_last_write; 63 } spi_bdev_t; 64 65 int32_t spi_bdev_ioctl(spi_bdev_t *bdev, uint32_t op, uint32_t arg); 66 int spi_bdev_readblocks(spi_bdev_t *bdev, uint8_t *dest, uint32_t block_num, uint32_t num_blocks); 67 int spi_bdev_writeblocks(spi_bdev_t *bdev, const uint8_t *src, uint32_t block_num, uint32_t num_blocks); 68 69 // These raw functions bypass the cache and go directly to SPI flash 70 int spi_bdev_readblocks_raw(spi_bdev_t *bdev, uint8_t *dest, uint32_t block_num, uint32_t block_offset, uint32_t num_bytes); 71 int spi_bdev_writeblocks_raw(spi_bdev_t *bdev, const uint8_t *src, uint32_t block_num, uint32_t block_offset, uint32_t num_bytes); 72 int spi_bdev_eraseblocks_raw(spi_bdev_t *bdev, uint32_t block_num, uint32_t num_bytes); 73 74 extern const struct _mp_obj_type_t pyb_flash_type; 75 extern const struct _pyb_flash_obj_t pyb_flash_obj; 76 77 struct _fs_user_mount_t; 78 void pyb_flash_init_vfs(struct _fs_user_mount_t *vfs); 79 80 #endif // MICROPY_INCLUDED_STM32_STORAGE_H 81