flash.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023, 2024 Adrian "asie" Siekierka
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#ifndef NILE_FLASH_H_
#define NILE_FLASH_H_
 
#include <wonderful.h>
#include "hardware.h"
 
#define NILE_FLASH_ID_W25Q16JV_IQ 0xEF4015
#define NILE_FLASH_ID_W25Q16JV_IM 0xEF7015
 
#define NILE_FLASH_SR1_BUSY      (1 << 0) 
#define NILE_FLASH_SR1_WEL       (1 << 1) 
#define NILE_FLASH_SR1_BP0       (1 << 2) 
#define NILE_FLASH_SR1_BP1       (1 << 3) 
#define NILE_FLASH_SR1_BP2       (1 << 4) 
#define NILE_FLASH_SR1_TB        (1 << 5) 
#define NILE_FLASH_SR1_SEC       (1 << 6) 
#define NILE_FLASH_SR1_CMP       (1 << 7) 
 
#define NILE_FLASH_SR2_SRL       (1 << 0) 
#define NILE_FLASH_SR2_LB1       (1 << 3) 
#define NILE_FLASH_SR2_LB2       (1 << 4) 
#define NILE_FLASH_SR2_LB3       (1 << 5) 
#define NILE_FLASH_SR2_CMP       (1 << 6) 
#define NILE_FLASH_SR2_SUS       (1 << 7) 
 
#define NILE_FLASH_SR3_WPS       (1 << 2) 
#define NILE_FLASH_SR3_DRV_100   (0)      
#define NILE_FLASH_SR3_DRV_75    (1 << 5) 
#define NILE_FLASH_SR3_DRV_50    (2 << 5) 
#define NILE_FLASH_SR3_DRV_25    (3 << 5) 
#define NILE_FLASH_SR3_DRV_MASK  (3 << 5) 
 
#define NILE_FLASH_CMD_WRSR1     0x01 
#define NILE_FLASH_CMD_WRITE     0x02 
#define NILE_FLASH_CMD_READ      0x03 
#define NILE_FLASH_CMD_WRDI      0x04 
#define NILE_FLASH_CMD_RDSR1     0x05 
#define NILE_FLASH_CMD_WREN      0x06 
#define NILE_FLASH_CMD_WRSR3     0x11 
#define NILE_FLASH_CMD_RDSR3     0x15 
#define NILE_FLASH_CMD_ERASE_4K  0x20 
#define NILE_FLASH_CMD_WRSR2     0x31 
#define NILE_FLASH_CMD_RDSR2     0x35 
#define NILE_FLASH_CMD_BLOCK_LOCK   0x36 
#define NILE_FLASH_CMD_BLOCK_UNLOCK 0x39 
#define NILE_FLASH_CMD_BLOCK_RDLOCK 0x3D 
#define NILE_FLASH_CMD_SEC_WRITE 0x42 
#define NILE_FLASH_CMD_SEC_ERASE 0x44 
#define NILE_FLASH_CMD_SEC_READ  0x48 
#define NILE_FLASH_CMD_RDUUID    0x4B 
#define NILE_FLASH_CMD_ERASE_32K 0x52 
#define NILE_FLASH_CMD_RDSFPD    0x5A 
#define NILE_FLASH_CMD_RESET_EN  0x66 
#define NILE_FLASH_CMD_SUSPEND   0x75 
#define NILE_FLASH_CMD_RESUME    0x7A 
#define NILE_FLASH_CMD_LOCK      0x7E 
#define NILE_FLASH_CMD_MFR_ID    0x90 
#define NILE_FLASH_CMD_UNLOCK    0x98 
#define NILE_FLASH_CMD_RESET     0x99 
#define NILE_FLASH_CMD_RDID      0x9F 
#define NILE_FLASH_CMD_WAKE_ID   0xAB 
#define NILE_FLASH_CMD_SLEEP     0xB9 
#define NILE_FLASH_CMD_ERASE_ALL 0xC7 
#define NILE_FLASH_CMD_ERASE_64K 0xD8 
 
#ifndef __ASSEMBLER__
#include <stdbool.h>
#include <stdint.h>

static inline bool nile_flash_write_unlock_global(void) {
    bool __nile_flash_cmd(uint8_t cmd);
    return __nile_flash_cmd(NILE_FLASH_CMD_WREN) && __nile_flash_cmd(NILE_FLASH_CMD_UNLOCK);
}

static inline bool nile_flash_write_enable(void) {
    bool __nile_flash_cmd(uint8_t cmd);
    return __nile_flash_cmd(NILE_FLASH_CMD_WREN);
}

static inline bool nile_flash_write_disable(void) {
    bool __nile_flash_cmd(uint8_t cmd);
    return __nile_flash_cmd(NILE_FLASH_CMD_WRDI);
}

static inline bool nile_flash_wake(void) {
    bool __nile_flash_cmd(uint8_t cmd);
    return __nile_flash_cmd(NILE_FLASH_CMD_WAKE_ID);
}

static inline bool nile_flash_sleep(void) {
    bool __nile_flash_cmd(uint8_t cmd);
    return __nile_flash_cmd(NILE_FLASH_CMD_SLEEP);
}

bool nile_flash_read_uuid(uint8_t *buffer);

uint32_t nile_flash_read_id(void);

bool nile_flash_read(void __far* buffer, uint32_t address, uint16_t size);

bool nile_flash_write_page(const void __far* buffer, uint32_t address, uint16_t size);

static inline bool nile_flash_erase_part(uint8_t type, uint32_t address) {
    bool __nile_flash_erase_address(uint32_t address);
    return __nile_flash_erase_address((((uint32_t) type) << 24) | address);
}
 
static inline uint8_t nile_flash_read_sr1(void) {
    uint8_t __nile_flash_read_sr(uint8_t value);
    return __nile_flash_read_sr(NILE_FLASH_CMD_RDSR1);
}
 
static inline uint8_t nile_flash_read_sr2(void) {
    uint8_t __nile_flash_read_sr(uint8_t value);
    return __nile_flash_read_sr(NILE_FLASH_CMD_RDSR2);
}
 
static inline uint8_t nile_flash_read_sr3(void) {
    uint8_t __nile_flash_read_sr(uint8_t value);
    return __nile_flash_read_sr(NILE_FLASH_CMD_RDSR3);
}
 
static inline bool nile_flash_write_sr1(uint8_t value) {
    bool __nile_flash_write_sr(uint16_t value);
    return __nile_flash_write_sr(NILE_FLASH_CMD_WRSR1 | (value << 8));
}
 
static inline bool nile_flash_write_sr2(uint8_t value) {
    bool __nile_flash_write_sr(uint16_t value);
    return __nile_flash_write_sr(NILE_FLASH_CMD_WRSR2 | (value << 8));
}
 
static inline bool nile_flash_write_sr3(uint8_t value) {
    bool __nile_flash_write_sr(uint16_t value);
    return __nile_flash_write_sr(NILE_FLASH_CMD_WRSR3 | (value << 8));
}

bool nile_flash_wait_ready(void);
 
#endif /* __ASSEMBLER__ */
 
#endif /* NILE_FLASH_H_ */