MTD: Add Initial Hyperbus support
Vignesh Raghavendra
maintainerv3 cover MTD: Add Initial Hyperbus support
Cypress HyperBus is Low Signal Count, High Performance Double Data Rate Bus interface between a host system master and one or more slave interfaces. HyperBus is used to connect microprocessor, microcontroller, or ASIC devices with random access NOR flash memory(called HyperFlash) or self refresh DRAM(called HyperRAM).
Its a 8-bit data bus (DQ[7:0]) with Read-Write Data Strobe (RWDS) signal and either Single-ended clock(3.0V parts) or Differential clock (1.8V parts). It uses ChipSelect lines to select b/w multiple slaves. At bus level, it follows a separate protocol described in HyperBus specification[1].
HyperFlash follows CFI AMD/Fujitsu Extended Command Set (0x0002) similar to that of existing parallel NORs. Since Hyperbus is x8 DDR bus, its equivalent to x16 parallel NOR flash wrt bits per clk. But Hyperbus operates at >166MHz frequencies.
HyperRAM provides direct random read/write access to flash memory array.
Framework is modelled along the lines of spi-nor framework. HyperBus memory controller(HBMC) drivers call hyperbus_register_device() to register a single HyperFlash device. HyperFlash core parses MMIO access information from DT, sets up the map_info struct, probes CFI flash and registers it with MTD framework.
This is an early RFC, to know if its okay to use maps framework and existing CFI compliant flash support code to support Hyperflash
Also would like input on different types of HBMC master IPs out there and their programming sequences.
Would appreciate any testing/review.
Tested on modified TI AM654 EVM with Cypress Hyperflash S26KS512 by creating a UBIFS partition and writing and reading files to it. Stress tested by writing/reading 16MB flash repeatedly at different offsets using dd commmand.
HyperBus specification can be found at[1]
HyperFlash datasheet can be found at[2]
TI's HBMC controller details at[3]
[1] https://www.cypress.com/file/213356/download
[2] https://www.cypress.com/file/213346/download
[3] http://www.ti.com/lit/ug/spruid7b/spruid7b.pdf
Table 12-5741. HyperFlash Access Sequence
Change log:
Since RFC v2:
* use map_word_xxx() for handling status register to support interleaved flashes as suggested by Joakim Tjernlund <[email protected]>
* Report error status/messages on erase/program failure by looking at status register bits.
* Add "cfi-flash" as fallback compatible for cypress,hyperflash
* Add support to select between HyperBus and OSPI using mmio mux
Since RFC v1:
* Re-work Hyperbus core to provide separate struct representation for controller and slave devices
* Rename all files and func names to have hyperbus_ prefix
* Provide default calibration routine for use by controller drivers
* Fix up errors with patch spliting
* Address comments by Sergei Shtylyov <[email protected]>
Vignesh Raghavendra (5):
mtd: cfi_cmdset_0002: Add support for polling status register
dt-bindings: mtd: Add binding documentation for HyperFlash
mtd: Add support for HyperBus memory devices
dt-bindings: mtd: Add bindings for TI's AM654 HyperBus memory
controller
mtd: hyperbus: Add driver for TI's HyperBus memory controller
.../bindings/mtd/cypress,hyperflash.txt | 6 + .../devicetree/bindings/mtd/ti,am654-hbmc.txt | 31 +++ MAINTAINERS | 8 + drivers/mtd/Kconfig | 2 + drivers/mtd/Makefile | 1 + drivers/mtd/chips/cfi_cmdset_0002.c | 90 ++++++++ drivers/mtd/hyperbus/Kconfig | 23 +++ drivers/mtd/hyperbus/Makefile | 4 + drivers/mtd/hyperbus/hbmc-am654.c | 115 +++++++++++ drivers/mtd/hyperbus/hyperbus-core.c | 192 ++++++++++++++++++ include/linux/mtd/cfi.h | 5 + include/linux/mtd/hyperbus.h | 91 +++++++++ 12 files changed, 568 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/cypress,hyperflash.txt create mode 100644 Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt create mode 100644 drivers/mtd/hyperbus/Kconfig create mode 100644 drivers/mtd/hyperbus/Makefile create mode 100644 drivers/mtd/hyperbus/hbmc-am654.c create mode 100644 drivers/mtd/hyperbus/hyperbus-core.c create mode 100644 include/linux/mtd/hyperbus.h
Signature · 6 lines
2.21.0 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
Vignesh Raghavendra
maintainerPATCH v3 1/5 mtd: cfi_cmdset_0002: Add support for polling status register
HyperFlash devices are compliant with CFI AMD/Fujitsu Extended Command Set(0x0002) for flash operations, therefore drivers/mtd/chips/cfi_cmdset_0002.c can be used as is. But these devices do not support DQ polling method of determining chip ready/good status. These flashes provide Status Register whose bits can be polled to know status of flash operation.
Cypress HyperFlash datasheet here[1], talks about CFI Amd/Fujitsu Extended Query version 1.5. Bit 0 of "Software Features supported" field of CFI Primary Vendor-Specific Extended Query table indicates presence/absence of status register and Bit 1 indicates whether or not DQ polling is supported. Using these bits, its possible to determine whether flash supports DQ polling or need to use Status Register.
Add support for polling Status Register to know device ready/status of erase/write operations when DQ polling is not supported. Print error messages on erase/program failure by looking at related Status Register bits.
[1] https://www.cypress.com/file/213346/download
--- drivers/mtd/chips/cfi_cmdset_0002.c | 90 +++++++++++++++++++++++++++++ include/linux/mtd/cfi.h | 5 ++ 2 files changed, 95 insertions(+)
drivers/mtd/chips/cfi_cmdset_0002.c +90 -0
@@ -49,6 +49,16 @@#define SST49LF008A 0x005a#define AT49BV6416 0x00d6 +/* +* Status Register bit description. Used by flash devices that don't +* support DQ polling (Eg.: HyperFlash) +*/ +#define CFI_SR_DRB BIT(7) +#define CFI_SR_ESB BIT(5) +#define CFI_SR_PSB BIT(4) +#define CFI_SR_WBASB BIT(3) +#define CFI_SR_SLSB BIT(1) +static int cfi_amdstd_read (struct mtd_info *,loff_t ,size_t ,size_t *,u_char *);static int cfi_amdstd_write_words (struct mtd_info *,loff_t ,size_t ,size_t *,const u_char *);static int cfi_amdstd_write_buffers (struct mtd_info *,loff_t ,size_t ,size_t *,const u_char *);
@@ -97,6 +107,48 @@ static struct mtd_chip_driver cfi_amdstd_chipdrv = { .module = THIS_MODULE }; +/* +* Use status register to poll for Erase/write completion when DQ is not +* supported. This is indicated by Bit[1:0] of SoftwareFeatures field in +* CFI Primary Vendor-Specific Extended Query table 1.5 +*/ +static int cfi_use_status_reg (struct cfi_private *cfi) +{ +struct cfi_pri_amdstd *extp = cfi->cmdset_priv; + +return (extp->MinorVersion >='5' ) && + (extp->SoftwareFeatures &0x3 ) ==0x1 ; +} + +static void cfi_check_err_status (struct map_info *map,unsigned long adr) +{ +struct cfi_private *cfi = map->fldrv_priv; +map_word status; + +if (!cfi_use_status_reg (cfi)) +return ; + +cfi_send_gen_cmd (0x70 , cfi->addr_unlock1,0 , map, cfi, + cfi->device_type,NULL ); + status =map_read (map, adr); + +if (map_word_bitsset (map, status,CMD (0x3a ))) { +unsigned long chipstatus =MERGESTATUS (status); + +if (chipstatus &CFI_SR_ESB ) +pr_err ("%s erase operation failed, status %lx\n" , + map->name, chipstatus); +if (chipstatus &CFI_SR_PSB ) +pr_err ("%s program operation failed, status %lx\n" , + map->name, chipstatus); +if (chipstatus &CFI_SR_WBASB ) +pr_err ("%s buffer program command aborted, status %lx\n" , + map->name, chipstatus); +if (chipstatus &CFI_SR_SLSB ) +pr_err ("%s sector write protected, status %lx\n" , + map->name, chipstatus); + } +}/* #define DEBUG_CFI_FEATURES */
@@ -744,8 +796,22 @@ static struct mtd_info *cfi_amdstd_setup(struct mtd_info *mtd)*/ static int __xipram chip_ready(struct map_info *map, unsigned long addr) { +struct cfi_private *cfi = map->fldrv_priv;map_word d, t; +if (cfi_use_status_reg (cfi)) { +map_word ready =CMD (CFI_SR_DRB ); +/* +* For chips that support status register, check device +* ready bit +*/ +cfi_send_gen_cmd (0x70 , cfi->addr_unlock1,0 , map, cfi, + cfi->device_type,NULL ); + d =map_read (map, addr); + +return map_word_andequal (map, d, ready, ready); + } + d =map_read (map, addr); t =map_read (map, addr);
@@ -769,8 +835,27 @@ static int __xipram chip_ready(struct map_info *map, unsigned long addr)*/ static int __xipram chip_good(struct map_info *map, unsigned long addr, map_word expected) { +struct cfi_private *cfi = map->fldrv_priv;map_word oldd, curd; +if (cfi_use_status_reg (cfi)) { +map_word ready =CMD (CFI_SR_DRB ); +map_word err =CMD (CFI_SR_PSB |CFI_SR_ESB ); +/* +* For chips that support status register, check device +* ready bit and Erase/Program status bit to know if +* operation succeeded. +*/ +cfi_send_gen_cmd (0x70 , cfi->addr_unlock1,0 , map, cfi, + cfi->device_type,NULL ); + curd =map_read (map, addr); + +if (map_word_andequal (map, curd, ready, ready)) +return !map_word_bitsset (map, curd, err); + +return 0 ; + } + oldd =map_read (map, addr); curd =map_read (map, addr);
@@ -1643,6 +1728,7 @@ static int __xipram do_write_oneword(struct map_info *map, struct flchip *chip,/* Did we succeed? */ if (!chip_good (map, adr, datum)) {/* reset on all failures. */ +cfi_check_err_status (map, adr);map_write (map,CMD (0xF0 ), chip->start);/* FIXME - should have reset delay before continuing */
@@ -1900,6 +1986,7 @@ static int __xipram do_write_buffer(struct map_info *map, struct flchip *chip,* See e.g. * http://www.spansion.com/Support/Application%20Notes/MirrorBit_Write_Buffer_Prog_Page_Buffer_Read_AN.pdf */ +cfi_check_err_status (map, adr);cfi_send_gen_cmd (0xAA , cfi->addr_unlock1, chip->start, map, cfi, cfi->device_type,NULL ); cfi_send_gen_cmd(0x55, cfi->addr_unlock2, chip->start, map, cfi,
@@ -2106,6 +2193,7 @@ static int do_panic_write_oneword(struct map_info *map, struct flchip *chip,if (!chip_good (map, adr, datum)) {/* reset on all failures. */ +cfi_check_err_status (map, adr);map_write (map,CMD (0xF0 ), chip->start);/* FIXME - should have reset delay before continuing */
@@ -2315,6 +2403,7 @@ static int __xipram do_erase_chip(struct map_info *map, struct flchip *chip)/* Did we succeed? */ if (ret) {/* reset on all failures. */ +cfi_check_err_status (map, adr);map_write (map,CMD (0xF0 ), chip->start);/* FIXME - should have reset delay before continuing */
@@ -2411,6 +2500,7 @@ static int __xipram do_erase_oneblock(struct map_info *map, struct flchip *chip,/* Did we succeed? */ if (ret) {/* reset on all failures. */ +cfi_check_err_status (map, adr);map_write (map,CMD (0xF0 ), chip->start);/* FIXME - should have reset delay before continuing */
include/linux/mtd/cfi.h +5 -0
@@ -233,6 +233,11 @@ struct cfi_pri_amdstd {uint8_t VppMin;uint8_t VppMax;uint8_t TopBottom; +/* Below field are added from version 1.5 */ +uint8_t ProgramSuspend; +uint8_t UnlockBypass; +uint8_t SecureSiliconSector; +uint8_t SoftwareFeatures; } __packed;/* Vendor-Specific PRI for Atmel chips (command set 0x0002) */
Signature · 1 line
2.21.0
Vignesh Raghavendra
maintainerPATCH v3 2/5 dt-bindings: mtd: Add binding documentation for HyperFlash
In reply to Vignesh RaghavendraAdd DT binding documentation for HyperFlash devices.
--- .../devicetree/bindings/mtd/cypress,hyperflash.txt | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/cypress,hyperflash.txt
Documentation/devicetree/bindings/mtd/cypress,hyperflash.txt new file +6 -0
@@ -0,0 +1,6 @@ +Bindings for HyperFlash NOR flash chips compliant with Cypress HyperBus +specification and supports Cypress CFI specification 1.5 command set. + +Required properties: +- compatible : "cypress,hyperflash", "cfi-flash" for HyperFlash NOR chips +- reg : Address where flash's memory mapped space
Signature · 1 line
2.21.0
Vignesh Raghavendra
maintainerPATCH v3 3/5 mtd: Add support for HyperBus memory devices
In reply to Vignesh RaghavendraCypress' HyperBus is Low Signal Count, High Performance Double Data Rate Bus interface between a host system master and one or more slave interfaces. HyperBus is used to connect microprocessor, microcontroller, or ASIC devices with random access NOR flash memory (called HyperFlash) or self refresh DRAM (called HyperRAM).
Its a 8-bit data bus (DQ[7:0]) with Read-Write Data Strobe (RWDS) signal and either Single-ended clock(3.0V parts) or Differential clock (1.8V parts). It uses ChipSelect lines to select b/w multiple slaves. At bus level, it follows a separate protocol described in HyperBus specification[1].
HyperFlash follows CFI AMD/Fujitsu Extended Command Set (0x0002) similar to that of existing parallel NORs. Since HyperBus is x8 DDR bus, its equivalent to x16 parallel NOR flash wrt bits per clock cycle. But HyperBus operates at >166MHz frequencies.
HyperRAM provides direct random read/write access to flash memory array.
But, HyperBus memory controllers seem to abstract implementation details and expose a simple MMIO interface to access connected flash.
Add support for registering HyperFlash devices with MTD framework. MTD maps framework along with CFI chip support framework are used to support communicating with flash.
Framework is modelled along the lines of spi-nor framework. HyperBus memory controller (HBMC) drivers calls hyperbus_register_device() to register a single HyperFlash device. HyperFlash core parses MMIO access information from DT, sets up the map_info struct, probes CFI flash and registers it with MTD framework.
Some HBMC masters need calibration/training sequence[3] to be carried out, in order for DLL inside the controller to lock, by reading a known string/pattern. This is done by repeatedly reading CFI Query Identification String. Calibration needs to be done before trying to detect flash as part of CFI flash probe.
HyperRAM is not supported at the moment.
HyperBus specification can be found at[1]
HyperFlash datasheet can be found at[2]
[1] https://www.cypress.com/file/213356/download
[2] https://www.cypress.com/file/213346/download
[3] http://www.ti.com/lit/ug/spruid7b/spruid7b.pdf
Table 12-5741. HyperFlash Access Sequence
--- MAINTAINERS | 7 + drivers/mtd/Kconfig | 2 + drivers/mtd/Makefile | 1 + drivers/mtd/hyperbus/Kconfig | 11 ++ drivers/mtd/hyperbus/Makefile | 3 + drivers/mtd/hyperbus/hyperbus-core.c | 192 +++++++++++++++++++++++++++ include/linux/mtd/hyperbus.h | 91 +++++++++++++ 7 files changed, 307 insertions(+) create mode 100644 drivers/mtd/hyperbus/Kconfig create mode 100644 drivers/mtd/hyperbus/Makefile create mode 100644 drivers/mtd/hyperbus/hyperbus-core.c create mode 100644 include/linux/mtd/hyperbus.h
MAINTAINERS +7 -0
@@ -7243,6 +7243,13 @@ F: include/uapi/linux/hyperv.h F: tools/hv/ F: Documentation/ABI/stable/sysfs-bus-vmbus +HYPERBUS SUPPORT +M: Vignesh Raghavendra <[email protected]> +S: Supported +F: drivers/mtd/hyperbus/ +F: include/linux/mtd/hyperbus.h +F: Documentation/devicetree/bindings/mtd/cypress,hyperbus.txt + HYPERVISOR VIRTUAL CONSOLE DRIVER L: [email protected] S: Odd Fixes
drivers/mtd/Kconfig +2 -0
@@ -289,4 +289,6 @@ source "drivers/mtd/spi-nor/Kconfig" source "drivers/mtd/ubi/Kconfig" +source "drivers/mtd/hyperbus/Kconfig" + endif # MTD
drivers/mtd/Makefile +1 -0
@@ -35,3 +35,4 @@ obj-y += chips/ lpddr/ maps/ devices/ nand/ tests/ obj-$(CONFIG_MTD_SPI_NOR) += spi-nor/ obj-$(CONFIG_MTD_UBI) += ubi/ +obj-$(CONFIG_MTD_HYPERBUS) += hyperbus/
drivers/mtd/hyperbus/Kconfig new file +11 -0
@@ -0,0 +1,11 @@ +menuconfig MTD_HYPERBUS + tristate "HyperBus support" + select MTD_CFI + select MTD_MAP_BANK_WIDTH_2 + select MTD_CFI_AMDSTD + select MTD_COMPLEX_MAPPINGS + help + This is the framework for the HyperBus which can be used by + the HyperBus Controller driver to communicate with + HyperFlash. See Cypress HyperBus specification for more + details
drivers/mtd/hyperbus/Makefile new file +3 -0
@@ -0,0 +1,3 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-$(CONFIG_MTD_HYPERBUS) += hyperbus-core.o
drivers/mtd/hyperbus/hyperbus-core.c new file +192 -0
192 lines not on this page · raw message
include/linux/mtd/hyperbus.h new file +91 -0
91 lines not on this page · raw message
Signature · 1 line
2.21.0
Re: [PATCH v3 3/5] mtd: Add support for HyperBus memory devices
Hello!
Quoted 49 lines · Vignesh Raghavendra
Cypress' HyperBus is Low Signal Count, High Performance Double Data Rate Bus interface between a host system master and one or more slave interfaces. HyperBus is used to connect microprocessor, microcontroller, or ASIC devices with random access NOR flash memory (called HyperFlash) or self refresh DRAM (called HyperRAM).
Its a 8-bit data bus (DQ[7:0]) with Read-Write Data Strobe (RWDS) signal and either Single-ended clock(3.0V parts) or Differential clock (1.8V parts). It uses ChipSelect lines to select b/w multiple slaves. At bus level, it follows a separate protocol described in HyperBus specification[1].
HyperFlash follows CFI AMD/Fujitsu Extended Command Set (
0x0002) similar to that of existing parallel NORs. Since HyperBus is x8 DDR bus, its equivalent to x16 parallel NOR flash wrt bits per clock cycle. But HyperBus operates at >166MHz frequencies.
HyperRAM provides direct random read/write access to flash memory array.But, HyperBus memory controllers seem to abstract implementation details and expose a simple MMIO interface to access connected flash.
Add support for registering HyperFlash devices with MTD framework. MTD maps framework along with CFI chip support framework are used to support communicating with flash.
Framework is modelled along the lines of spi-nor framework. HyperBus memory controller (HBMC) drivers calls
hyperbus_register_device()to register a single HyperFlash device. HyperFlash core parses MMIO access information from DT, sets up themap_infostruct, probes CFI flash and registers it with MTD framework.Some HBMC masters need calibration/training sequence[3] to be carried out, in order for DLL inside the controller to lock, by reading a known string/pattern. This is done by repeatedly reading CFI Query Identification String. Calibration needs to be done before trying to detect flash as part of CFI flash probe.
HyperRAM is not supported at the moment.
HyperBus specification can be found at[1]
HyperFlash datasheet can be found at[2][1] https://www.cypress.com/file/213356/download
[2] https://www.cypress.com/file/213346/download
[3] http://www.ti.com/lit/ug/spruid7b/spruid7b.pdf
Table 12-5741. HyperFlash Access SequenceSigned-off-by Vignesh Raghavendra <[email protected]>
[...]
Quoted 36 lines
drivers/mtd/hyperbus/Kconfig new file +11
-0@@ -0,0 +1,11 @@ +menuconfig MTD_HYPERBUS + tristate "HyperBus support" + select MTD_CFI + select MTD_MAP_BANK_WIDTH_2 + select MTD_CFI_AMDSTD + select MTD_COMPLEX_MAPPINGS + help + This is the framework for the HyperBus which can be used by + the HyperBus Controller driver to communicate with + HyperFlash. See Cypress HyperBus specification for more + detailsdrivers/mtd/hyperbus/Makefile new file +3
-0@@ -0,0 +1,3 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-$(CONFIG_MTD_HYPERBUS) += hyperbus-core.odrivers/mtd/hyperbus/hyperbus-core.c new file +4
-0@@ -0,0 +1,192 @@ +// SPDX-License-Identifier: GPL-2.0 +// +// Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/ +// Author: Vignesh Raghavendra <[email protected]>
[...]
Quoted 12 lines
drivers/mtd/hyperbus/hyperbus-core.c new file +12
-0+/* Default calibration routine for use by HyperBus controller. +* Controller is calibrated by repeatedly reading known pattern ("QRY" +* string from CFI space) +* Lets ensure "QRY" string is read correctly at least 5 times to ensure +* stability of the DLL lock. +*/ +int hyperbus_calibrate (struct hyperbus_device *hbdev) +{ +struct map_info *map = &hbdev->map; +struct cfi_private cfi; +int count =HYPERBUS_CALIB_COUNT ; +int pass_count =0 ;
drivers/mtd/hyperbus/hyperbus-core.c line 83
Quoted 10 lines
drivers/mtd/hyperbus/hyperbus-core.c new file +10
-0+int ret; + + cfi.interleave =1 ; + cfi.device_type =CFI_DEVICETYPE_X16 ; +cfi_send_gen_cmd (0xF0 ,0 ,0 , map, &cfi, cfi.device_type,NULL ); +cfi_send_gen_cmd (0x98 ,0x55 ,0 , map, &cfi, cfi.device_type,NULL ); + +while (count--) { +cfi_qry_present (map,0 , &cfi); + ret =cfi_qry_present (map,0 , &cfi);
Why call it twice in a row?
Quoted 13 lines
drivers/mtd/hyperbus/hyperbus-core.c new file +13
-0+if (ret) + pass_count++; +else + pass_count =0 ; +if (pass_count ==5 ) +break ; + } + +cfi_qry_mode_off (0 , map, &cfi); + +return ret; +} +EXPORT_SYMBOL_GPL (hyperbus_calibrate);
[...]
Quoted 6 lines
include/linux/mtd/hyperbus.h new file +0
-0@@ -0,0 +1,91 @@
[...]
Quoted 2 lines
+/**
+ *hb_unregister_device- deregister HyperBus slave memory device
You forgot to update the function name in the kernel-doc. :-)
include/linux/mtd/hyperbus.h line 91
Quoted 7 lines
+ * @hbdev:
hyperbus_deviceto be unregistered
+ *
+ * Return: 0 for success, others for failure.
+ */include/linux/mtd/hyperbus.h new file +3
-0+int hyperbus_unregister_device (struct hyperbus_device *hbdev); + +#endif /* __LINUX_MTD_HYPERBUS_H__ */
MBR, Sergei
Vignesh Raghavendra
maintainerRe: [PATCH v3 3/5] mtd: Add support for HyperBus memory devices
Hi,
Quoted 107 lines · Sergei Shtylyov
Hello!
Quoted 49 lines · Vignesh Raghavendra
Cypress' HyperBus is Low Signal Count, High Performance Double Data Rate Bus interface between a host system master and one or more slave interfaces. HyperBus is used to connect microprocessor, microcontroller, or ASIC devices with random access NOR flash memory (called HyperFlash) or self refresh DRAM (called HyperRAM).
Its a 8-bit data bus (DQ[7:0]) with Read-Write Data Strobe (RWDS) signal and either Single-ended clock(3.0V parts) or Differential clock (1.8V parts). It uses ChipSelect lines to select b/w multiple slaves. At bus level, it follows a separate protocol described in HyperBus specification[1].
HyperFlash follows CFI AMD/Fujitsu Extended Command Set (
0x0002) similar to that of existing parallel NORs. Since HyperBus is x8 DDR bus, its equivalent to x16 parallel NOR flash wrt bits per clock cycle. But HyperBus operates at >166MHz frequencies.
HyperRAM provides direct random read/write access to flash memory array.But, HyperBus memory controllers seem to abstract implementation details and expose a simple MMIO interface to access connected flash.
Add support for registering HyperFlash devices with MTD framework. MTD maps framework along with CFI chip support framework are used to support communicating with flash.
Framework is modelled along the lines of spi-nor framework. HyperBus memory controller (HBMC) drivers calls
hyperbus_register_device()to register a single HyperFlash device. HyperFlash core parses MMIO access information from DT, sets up themap_infostruct, probes CFI flash and registers it with MTD framework.Some HBMC masters need calibration/training sequence[3] to be carried out, in order for DLL inside the controller to lock, by reading a known string/pattern. This is done by repeatedly reading CFI Query Identification String. Calibration needs to be done before trying to detect flash as part of CFI flash probe.
HyperRAM is not supported at the moment.
HyperBus specification can be found at[1]
HyperFlash datasheet can be found at[2][1] https://www.cypress.com/file/213356/download
[2] https://www.cypress.com/file/213346/download
[3] http://www.ti.com/lit/ug/spruid7b/spruid7b.pdf
Table 12-5741. HyperFlash Access SequenceSigned-off-by Vignesh Raghavendra <[email protected]>[...]
Quoted 36 lines
drivers/mtd/hyperbus/Kconfig new file +11
-0@@ -0,0 +1,11 @@ +menuconfig MTD_HYPERBUS + tristate "HyperBus support" + select MTD_CFI + select MTD_MAP_BANK_WIDTH_2 + select MTD_CFI_AMDSTD + select MTD_COMPLEX_MAPPINGS + help + This is the framework for the HyperBus which can be used by + the HyperBus Controller driver to communicate with + HyperFlash. See Cypress HyperBus specification for more + detailsdrivers/mtd/hyperbus/Makefile new file +3
-0@@ -0,0 +1,3 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-$(CONFIG_MTD_HYPERBUS) += hyperbus-core.odrivers/mtd/hyperbus/hyperbus-core.c new file +4
-0@@ -0,0 +1,192 @@ +// SPDX-License-Identifier: GPL-2.0 +// +// Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/ +// Author: Vignesh Raghavendra <[email protected]> [...]
Quoted 16 lines
drivers/mtd/hyperbus/hyperbus-core.c new file +16
-0+/* Default calibration routine for use by HyperBus controller. +* Controller is calibrated by repeatedly reading known pattern ("QRY" +* string from CFI space) +* Lets ensure "QRY" string is read correctly at least 5 times to ensure +* stability of the DLL lock. +*/ +int hyperbus_calibrate (struct hyperbus_device *hbdev) +{ +struct map_info *map = &hbdev->map; +struct cfi_private cfi; +int count =HYPERBUS_CALIB_COUNT ; +int pass_count =0 ; +int ret; + + cfi.interleave =1 ; + cfi.device_type =CFI_DEVICETYPE_X16 ;
Quoted 9 lines
drivers/mtd/hyperbus/hyperbus-core.c line 83
Quoted 6 lines
drivers/mtd/hyperbus/hyperbus-core.c new file +6
-0+cfi_send_gen_cmd (0xF0 ,0 ,0 , map, &cfi, cfi.device_type,NULL ); +cfi_send_gen_cmd (0x98 ,0x55 ,0 , map, &cfi, cfi.device_type,NULL ); + +while (count--) { +cfi_qry_present (map,0 , &cfi); + ret =cfi_qry_present (map,0 , &cfi);Why call it twice in a row?
Oops, will fix in v2
Quoted 21 lines
Quoted 13 lines
drivers/mtd/hyperbus/hyperbus-core.c new file +13
-0+if (ret) + pass_count++; +else + pass_count =0 ; +if (pass_count ==5 ) +break ; + } + +cfi_qry_mode_off (0 , map, &cfi); + +return ret; +} +EXPORT_SYMBOL_GPL (hyperbus_calibrate);[...]
Quoted 6 lines
include/linux/mtd/hyperbus.h new file +0
-0@@ -0,0 +1,91 @@[...]
Quoted 5 lines
Quoted 2 lines
+/**
+ *hb_unregister_device- deregister HyperBus slave memory deviceYou forgot to update the function name in the kernel-doc. :-)
Indeed, thanks for catching this!
Quoted 10 lines
include/linux/mtd/hyperbus.h line 91
Quoted 7 lines
+ * @hbdev:
hyperbus_deviceto be unregistered
+ *
+ * Return: 0 for success, others for failure.
+ */include/linux/mtd/hyperbus.h new file +3
-0+int hyperbus_unregister_device (struct hyperbus_device *hbdev); + +#endif /* __LINUX_MTD_HYPERBUS_H__ */ MBR, Sergei
Signature · 7 lines
Regards Vignesh _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Vignesh Raghavendra
maintainerPATCH v3 4/5 dt-bindings: mtd: Add bindings for TI's AM654 HyperBus memory controller
In reply to Vignesh RaghavendraAdd binding documentation for TI's HyperBus memory controller present on AM654 SoC.
--- .../devicetree/bindings/mtd/ti,am654-hbmc.txt | 31 +++++++++++++++++++ MAINTAINERS | 1 + 2 files changed, 32 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +31 -0
@@ -0,0 +1,31 @@ +Bindings for HyperBus Memory Controller (HBMC) on TI's K3 family of SoCs + +Required properties: +- compatible : "ti,am654-hbmc" for AM654 SoC +- reg : Two entries: + First entry pointed to the register space of HBMC controller + Second entry pointing to the memory map region dedicated for + MMIO access to attached flash devices +- ranges : Address range allocated for each chipselect in the MMIO space + +Optional properties: +- mux-controls: phandle to the multiplexer that controls selection of + HBMC vs OSPI. Mux state of 1 indicates HBMC is selected. + +Example: + hbmc: hbmc@47034000 { + compatible = "ti,am654-hbmc"; + reg = <0x0 0x47034000 0x0 0x100>, + <0x5 0x00000000 0x1 0x0000000>; + power-domains = <&k3_pds 55>; + #address-cells = <1>; + #size-cells = <1>; + ranges = <0x0 0x5 0x00000000 0x4000000>, /* CS0 - 64MB */ + <0x1 0x5 0x04000000 0x4000000>; /* CS1 - 64MB + + /* Slave flash node */ + flash@0{ + compatible = "cypress,hyperflash"; + reg = <0x0 0x4000000>; + }; + };
MAINTAINERS +1 -0
@@ -7249,6 +7249,7 @@ S: Supported F: drivers/mtd/hyperbus/ F: include/linux/mtd/hyperbus.h F: Documentation/devicetree/bindings/mtd/cypress,hyperbus.txt +F: Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt HYPERVISOR VIRTUAL CONSOLE DRIVER L: [email protected]
Signature · 1 line
2.21.0
Re: [PATCH v3 4/5] dt-bindings: mtd: Add bindings for TI's AM654 HyperBus memory controller
Quoted 16 lines · Vignesh Raghavendra
Add binding documentation for TI's HyperBus memory controller present on AM654 SoC.
Signed-off-by Vignesh Raghavendra <[email protected]>--- .../devicetree/bindings/mtd/ti,am654-hbmc.txt | 31 +++++++++++++++++++ MAINTAINERS | 1 + 2 files changed, 32 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txtDocumentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +0
-0@@ -0,0 +1,31 @@
[...]
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt line 13
Quoted 3 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +3
-0+Optional properties: +- mux-controls: phandle to the multiplexer that controls selection of + HBMC vs OSPI. Mux state of 1 indicates HBMC is selected.
I thought this is usually done with the help of drivers/pinctrl/..
Quoted 4 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +4
-0+ +Example: + hbmc: hbmc@47034000 { + compatible = "ti,am654-hbmc";
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt line 27
Quoted 10 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +10
-0+ reg = <0x0 0x47034000 0x0 0x100>, + <0x5 0x00000000 0x1 0x0000000>; + power-domains = <&k3_pds 55>; + #address-cells = <1>; + #size-cells = <1>; + ranges = <0x0 0x5 0x00000000 0x4000000>, /* CS0 - 64MB */ + <0x1 0x5 0x04000000 0x4000000>; /* CS1 - 64MB + + /* Slave flash node */ + flash@0{
Need space before {.
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt line 31
Quoted 4 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +4
-0+ compatible = "cypress,hyperflash"; + reg = <0x0 0x4000000>; + }; + };
[...]
MBR, Sergei
Vignesh Raghavendra
maintainerRe: [PATCH v3 4/5] dt-bindings: mtd: Add bindings for TI's AM654 HyperBus memory controller
Quoted 19 lines · Sergei Shtylyov
Quoted 16 lines · Vignesh Raghavendra
Add binding documentation for TI's HyperBus memory controller present on AM654 SoC.
Signed-off-by Vignesh Raghavendra <[email protected]>--- .../devicetree/bindings/mtd/ti,am654-hbmc.txt | 31 +++++++++++++++++++ MAINTAINERS | 1 + 2 files changed, 32 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txtDocumentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +0
-0@@ -0,0 +1,31 @@[...]
Quoted 6 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt line 13
Quoted 3 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +3
-0+Optional properties: +- mux-controls: phandle to the multiplexer that controls selection of + HBMC vs OSPI. Mux state of 1 indicates HBMC is selected.I thought this is usually done with the help of
drivers/pinctrl/..
This mux is internal to SoC and not at SoC pad level. Based on this bit read/write requests at SoC interconnect is routed either to OSPI or HBMC, hence mmio-mux is a good fit
OSPI and HBMC data pins are themselves at pad level which is handled by pinctrl-single node.
Quoted 8 lines
Quoted 8 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +8
-0+ +Example: + hbmc: hbmc@47034000 { + compatible = "ti,am654-hbmc"; + reg = <0x0 0x47034000 0x0 0x100>, + <0x5 0x00000000 0x1 0x0000000>; + power-domains = <&k3_pds 55>; + #address-cells = <1>;
Quoted 9 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt line 27
Quoted 6 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +6
-0+ #size-cells = <1>; + ranges = <0x0 0x5 0x00000000 0x4000000>, /* CS0 - 64MB */ + <0x1 0x5 0x04000000 0x4000000>; /* CS1 - 64MB + + /* Slave flash node */ + flash@0{Need space before {.
Will fix.
Quoted 8 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt line 31
Quoted 4 lines
Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt new file +4
-0+ compatible = "cypress,hyperflash"; + reg = <0x0 0x4000000>; + }; + };[...]
MBR, Sergei
Signature · 6 lines
Regards Vignesh ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
Vignesh Raghavendra
maintainerPATCH v3 5/5 mtd: hyperbus: Add driver for TI's HyperBus memory controller
In reply to Vignesh RaghavendraAdd driver for HyperBus memory controller on TI's AM654 SoC. Programming IP is pretty simple and provides direct memory mapped access to connected Flash devices.
Add basic support for the IP without DMA. Second chipSelect is not supported for now.
--- drivers/mtd/hyperbus/Kconfig | 12 ++++ drivers/mtd/hyperbus/Makefile | 1 + drivers/mtd/hyperbus/hbmc-am654.c | 115 ++++++++++++++++++++++++++++++ 3 files changed, 128 insertions(+) create mode 100644 drivers/mtd/hyperbus/hbmc-am654.c
drivers/mtd/hyperbus/Kconfig +12 -0
@@ -9,3 +9,15 @@ menuconfig MTD_HYPERBUS the HyperBus Controller driver to communicate with HyperFlash. See Cypress HyperBus specification for more details + +if MTD_HYPERBUS + +config HBMC_AM654 + tristate "HyperBus controller driver for AM65x SoC" + select MULTIPLEXER + select MUX_MMIO + help + This is the driver for HyperBus controller on TI's AM65x and + other SoCs + +endif # MTD_HYPERBUS
drivers/mtd/hyperbus/Makefile +1 -0
@@ -1,3 +1,4 @@ # SPDX-License-Identifier: GPL-2.0 obj-$(CONFIG_MTD_HYPERBUS) += hyperbus-core.o +obj-$(CONFIG_HBMC_AM654) += hbmc-am654.o
drivers/mtd/hyperbus/hbmc-am654.c new file +115 -0
115 lines not on this page · raw message
Signature · 1 line
2.21.0
Vignesh Raghavendra
maintainerHi Sergei,
Quoted 8 lines · Vignesh Raghavendra
Vignesh Raghavendra (5):
mtd:cfi_cmdset_0002: Add support for polling status register
dt-bindings: mtd: Add binding documentation for HyperFlash
mtd: Add support for HyperBus memory devices
dt-bindings: mtd: Add bindings for TI's AM654 HyperBus memory
controller
mtd: hyperbus: Add driver for TI's HyperBus memory controller
Thanks for all the reviews!
Were you able to test this series with your hardware? Would like to get this into v5.2-rc1 if possible
Regards
Vignesh
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
Hello!
Quoted 11 lines · Vignesh Raghavendra
Quoted 8 lines
Vignesh Raghavendra (5):
mtd:cfi_cmdset_0002: Add support for polling status register
dt-bindings: mtd: Add binding documentation for HyperFlash
mtd: Add support for HyperBus memory devices
dt-bindings: mtd: Add bindings for TI's AM654 HyperBus memory
controller
mtd: hyperbus: Add driver for TI's HyperBus memory controllerThanks for all the reviews!
Were you able to test this series with your hardware? Would like to get this into v5.2-rc1 if possible
Not yet, and I still haven't ported my driver to use your HyperBus code.
Quoted 2 lines
Regards
Vignesh
MBR, Sergei