drivers/mtd/spi/sf_internal.h

   1 /*
   2  * SPI flash internal definitions
   3  *
   4  * Copyright (C) 2008 Atmel Corporation
   5  * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
   6  *
   7  * SPDX-License-Identifier:     GPL-2.0+
   8  */
   9
  10 #ifndef _SF_INTERNAL_H_
  11 #define _SF_INTERNAL_H_
  12
  13 #define SPI_FLASH_16MB_BOUN             0x1000000
  14
  15 /* SECT flags */
  16 #define SECT_4K                         (1 << 1)
  17 #define SECT_32K                        (1 << 2)
  18 #define E_FSR                           (1 << 3)
  19
  20 /* Erase commands */
  21 #define CMD_ERASE_4K                    0x20
  22 #define CMD_ERASE_32K                   0x52
  23 #define CMD_ERASE_CHIP                  0xc7
  24 #define CMD_ERASE_64K                   0xd8
  25
  26 /* Write commands */
  27 #define CMD_WRITE_STATUS                0x01
  28 #define CMD_PAGE_PROGRAM                0x02
  29 #define CMD_WRITE_DISABLE               0x04
  30 #define CMD_READ_STATUS                 0x05
  31 #define CMD_READ_STATUS1                0x35
  32 #define CMD_WRITE_ENABLE                0x06
  33 #define CMD_READ_CONFIG                 0x35
  34 #define CMD_FLAG_STATUS                 0x70
  35
  36 /* Read commands */
  37 #define CMD_READ_ARRAY_SLOW             0x03
  38 #define CMD_READ_ARRAY_FAST             0x0b
  39 #define CMD_READ_DUAL_OUTPUT_FAST       0x3b
  40 #define CMD_READ_DUAL_IO_FAST           0xbb
  41 #define CMD_READ_ID                     0x9f
  42
  43 /* Bank addr access commands */
  44 #ifdef CONFIG_SPI_FLASH_BAR
  45 # define CMD_BANKADDR_BRWR              0x17
  46 # define CMD_BANKADDR_BRRD              0x16
  47 # define CMD_EXTNADDR_WREAR             0xC5
  48 # define CMD_EXTNADDR_RDEAR             0xC8
  49 #endif
  50
  51 /* Common status */
  52 #define STATUS_WIP                      0x01
  53 #define STATUS_PEC                      0x80
  54
  55 /* Flash timeout values */
  56 #define SPI_FLASH_PROG_TIMEOUT          (2 * CONFIG_SYS_HZ)
  57 #define SPI_FLASH_PAGE_ERASE_TIMEOUT    (5 * CONFIG_SYS_HZ)
  58 #define SPI_FLASH_SECTOR_ERASE_TIMEOUT  (10 * CONFIG_SYS_HZ)
  59
  60 /* SST specific */
  61 #ifdef CONFIG_SPI_FLASH_SST
  62 # define SST_WP                 0x01    /* Supports AAI word program */
  63 # define CMD_SST_BP             0x02    /* Byte Program */
  64 # define CMD_SST_AAI_WP         0xAD    /* Auto Address Incr Word Program */
  65
  66 int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len,
  67                 const void *buf);
  68 #endif
  69
  70 /* Send a single-byte command to the device and read the response */
  71 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
  72
  73 /*
  74  * Send a multi-byte command to the device and read the response. Used
  75  * for flash array reads, etc.
  76  */
  77 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
  78                 size_t cmd_len, void *data, size_t data_len);
  79
  80 /*
  81  * Send a multi-byte command to the device followed by (optional)
  82  * data. Used for programming the flash array, etc.
  83  */
  84 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
  85                 const void *data, size_t data_len);
  86
  87
  88 /* Flash erase(sectors) operation, support all possible erase commands */
  89 int spi_flash_cmd_erase_ops(struct spi_flash *flash, u32 offset, size_t len);
  90
  91 /* Program the status register */
  92 int spi_flash_cmd_write_status(struct spi_flash *flash, u8 sr);
  93
  94 /* Set quad enbale bit */
  95 int spi_flash_set_qeb(struct spi_flash *flash);
  96
  97 /* Enable writing on the SPI flash */
  98 static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
  99 {
 100         return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
 101 }
 102
 103 /* Disable writing on the SPI flash */
 104 static inline int spi_flash_cmd_write_disable(struct spi_flash *flash)
 105 {
 106         return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0);
 107 }
 108
 109 /*
 110  * Send the read status command to the device and wait for the wip
 111  * (write-in-progress) bit to clear itself.
 112  */
 113 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
 114
 115 /*
 116  * Used for spi_flash write operation
 117  * - SPI claim
 118  * - spi_flash_cmd_write_enable
 119  * - spi_flash_cmd_write
 120  * - spi_flash_cmd_wait_ready
 121  * - SPI release
 122  */
 123 int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
 124                 size_t cmd_len, const void *buf, size_t buf_len);
 125
 126 /*
 127  * Flash write operation, support all possible write commands.
 128  * Write the requested data out breaking it up into multiple write
 129  * commands as needed per the write size.
 130  */
 131 int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
 132                 size_t len, const void *buf);
 133
 134 /*
 135  * Same as spi_flash_cmd_read() except it also claims/releases the SPI
 136  * bus. Used as common part of the ->read() operation.
 137  */
 138 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
 139                 size_t cmd_len, void *data, size_t data_len);
 140
 141 /* Flash read operation, support all possible read commands */
 142 int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
 143                 size_t len, void *data);
 144
 145 #endif /* _SF_INTERNAL_H_ */