Implement OCOTP driver for Vybrid using NVMEM
Subsystems (5)
v7 cover Implement OCOTP driver for Vybrid using NVMEM
Hello,
This patchset is based on top of v9 of Srinivas's NVMEM framework patches.
Sample output on Colibri VF61
root at colibri-vf:/sys/bus/nvmem/devices/ocotp0# hexdump nvmem 0000000 0000 0000 0000 0000 0000 0000 0000 0000
*
0000410 72a6 df64 0000 0000 0000 0000 0000 0000 0000420 39d4 2807 0000 0000 0000 0000 0000 0000 0000430 0000 0000 0000 0000 0000 0000 0000 0000
*
0000450 0280 0000 0000 0000 0000 0000 0000 0000 0000460 0000 0000 0000 0000 0000 0000 0000 0000
*
0000880 8f01 0000 0000 0000 0000 0000 0000 0000 0000890 0000 0000 0000 0000 0000 0000 0000 0000
*
00008c0 0000 1500 0000 0000 0000 0000 0000 0000 00008d0 330d 0800 0000 0000 0000 0000 0000 0000 00008e0 0000 e100 0000 0000 0000 0000 0000 0000 00008f0 0000 0000 0000 0000 0000 0000 0000 0000
*
0000c80 bada bada 0000 0000 0000 0000 0000 0000
*
0000cc0 0000 0000 0000 0000 0000 0000 0000 0000
*
0000cf0
The driver has changed quite a bit from the first version relying on of_platform_populate in mach file, to using SoC driver under drivers/soc and finally to NVMEM.
Feedback and comments most welcome.
Version 6 RFC patches can be found here
http://lkml.iu.edu/hypermail/linux/kernel/1506.2/05123.html
Version 5 of the patchset can be found here
http://lkml.iu.edu/hypermail/linux/kernel/1506.0/03787.html
Version 4 of the patchset can be found here
https://lkml.org/lkml/2015/5/26/199
Version 3 of the patchset can be found here
http://www.spinics.net/lists/arm-kernel/msg420847.html
Version 2 of the patchset can be found here
http://www.spinics.net/lists/devicetree/msg80654.html
Version 1 of the patchset can be found here
http://www.spinics.net/lists/devicetree/msg80257.html
The RFC version can be found here
https://lkml.org/lkml/2015/5/11/13
Changes since v6:
1. Use the v9 of NVMEM framework patchset
2. Add a few comments
3. Initialise buffer address not part of the fuse map to 0 instead of only handling buffer locations with valid fuse addresses.
Changes since v5:
Use NVMEM framework by Srinivas and Maxime
Changes since v4:
1. Use devm_* family of functions and use a struct to get rid of global variables (suggested by Joachim Eastwood)
2. Make Kconfig govern the compilation with tristate, instead of earlier bool. Paul Bolle raised a valid point that perhaps this should have been built in with the bool, however I had not taken into consideration generic distro kernels and it makes sense to have this tristated. (comments from Paul Bolle and Andreas Farber)
Changes since v3:
Instead of using the syscon_regmap_lookup_by_compatible function use a phandle in the device tree along with offsets specified in this phandle node and then read the offset along with the device node in the driver for reading from the required region.
Changes since v2:
Implement the SoC bus code as a driver in drivers/soc by registering with fsl,mscm-cpucfg as per Arnd's feedback
Changes since v1:
Sort the headers in alphabetical order
Changes since RFC:
Use a DT entry for the ROM area while specifying it as syscon.
Thanks & Regards,
Sanchayan Maity.
Sanchayan Maity (4):
clk: clk-vf610: Add clock for Vybrid OCOTP controller
ARM: dts: vfxxx: Add OCOTP node
drivers: nvmem: Add Vybrid OCOTP support
nvmem: Add DT binding documentation for Vybrid OCOTP driver
.../devicetree/bindings/nvmem/vf610-ocotp.txt | 20 ++ arch/arm/boot/dts/vfxxx.dtsi | 9 + drivers/clk/imx/clk-vf610.c | 1 + drivers/nvmem/Kconfig | 10 + drivers/nvmem/Makefile | 2 + drivers/nvmem/vf610-ocotp.c | 297 +++++++++++++++++++++ include/dt-bindings/clock/vf610-clock.h | 3 +- 7 files changed, 341 insertions(+), 1 deletion(-) create mode 100644 Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt create mode 100644 drivers/nvmem/vf610-ocotp.c
Signature · 1 line
2.5.0
PATCH v7 1/4 clk: clk-vf610: Add clock for Vybrid OCOTP controller
Add clock support for Vybrid On-Chip One Time Programmable (OCOTP) controller.
While the OCOTP block does not require explicit clock gating, for programming the OCOTP timing register the clock rate of ipg clock is required for timing calculations related to fuse and shadow register read sequence. We explicitly specify the ipg clock for OCOTP as a result.
--- drivers/clk/imx/clk-vf610.c | 1 + include/dt-bindings/clock/vf610-clock.h | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-)
drivers/clk/imx/clk-vf610.c +1 -0
@@ -387,6 +387,7 @@ static void __init vf610_clocks_init(struct device_node *ccm_node) clk[VF610_CLK_SNVS ] =imx_clk_gate2 ("snvs-rtc" ,"ipg_bus" ,CCM_CCGR6 ,CCM_CCGRx_CGn (7 )); clk[VF610_CLK_DAP ] =imx_clk_gate ("dap" ,"platform_bus" ,CCM_CCSR ,24 ); + clk[VF610_CLK_OCOTP ] =imx_clk_gate ("ocotp" ,"ipg_bus" ,CCM_CCGR6 ,CCM_CCGRx_CGn (5 ));imx_check_clocks (clk,ARRAY_SIZE (clk));
include/dt-bindings/clock/vf610-clock.h +2 -1
@@ -194,6 +194,7 @@#define VF610_PLL7_BYPASS 181#define VF610_CLK_SNVS 182#define VF610_CLK_DAP 183 -#define VF610_CLK_END 184 +#define VF610_CLK_OCOTP 184 +#define VF610_CLK_END 185#endif /* __DT_BINDINGS_CLOCK_VF610_H */
Signature · 1 line
2.5.0
PATCH v7 2/4 ARM: dts: vfxxx: Add OCOTP node
In reply to Sanchayan MaityAdd device tree node for the On-Chip One Time Programmable controller (OCOTP) on the Vybrid platform.
--- arch/arm/boot/dts/vfxxx.dtsi | 9 +++++++++ 1 file changed, 9 insertions(+)
arch/arm/boot/dts/vfxxx.dtsi +9 -0
@@ -419,6 +419,15 @@ status = "disabled"; }; + ocotp: ocotp at 400a5000 { + compatible = "fsl,vf610-ocotp"; + #address-cells = <1>; + #size-cells = <1>; + reg = <0x400a5000 0xD00>; + clocks = <&clks VF610_CLK_OCOTP>; + clock-names = "ocotp"; + }; + snvs0: snvs at 400a7000 { compatible = "fsl,sec-v4.0-mon", "syscon", "simple-mfd"; reg = <0x400a7000 0x2000>;
Signature · 1 line
2.5.0
PATCH v7 3/4 drivers: nvmem: Add Vybrid OCOTP support
In reply to Sanchayan MaityThe patch adds support for the On Chip One Time Programmable Peripheral (OCOTP) on the Vybrid platform.
--- drivers/nvmem/Kconfig | 10 ++ drivers/nvmem/Makefile | 2 + drivers/nvmem/vf610-ocotp.c | 297 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 309 insertions(+) create mode 100644 drivers/nvmem/vf610-ocotp.c
drivers/nvmem/Kconfig +10 -0
@@ -47,4 +47,14 @@ config NVMEM_IMX_OCOTP This driver can also be built as a module. If so, the module will be called nvmem-imx-ocotp. +config NVMEM_VF610_OCOTP + tristate "VF610_SoCs OCOTP support" + depends on SOC_VF610 + help + This is a driver for the 'OCOTP' peripheral available on Vybrid + devices like VF5xx and VF6xx. + + This driver can also be built as a module. If so, the module will + be called nvmem-vf610-ocotp. + endif
drivers/nvmem/Makefile +2 -0
@@ -12,3 +12,5 @@ obj-$(CONFIG_NVMEM_SUNXI_SID) += nvmem_sunxi_sid.o nvmem_sunxi_sid-y := sunxi_sid.o obj-$(CONFIG_NVMEM_IMX_OCOTP) += nvmem-imx-ocotp.o nvmem-imx-ocotp-y := imx-ocotp.o +obj-$(CONFIG_NVMEM_VF610_OCOTP) += nvmem-vf610-ocotp.o +nvmem-vf610-ocotp-y := vf610-ocotp.o
drivers/nvmem/vf610-ocotp.c new file +297 -0
297 lines not on this page · raw message
Signature · 1 line
2.5.0
PATCH v7 4/4 nvmem: Add DT binding documentation for Vybrid OCOTP driver
In reply to Sanchayan MaityAdd the devicetree bindings for the Freescale Vybrid On-Chip OTP driver.
--- .../devicetree/bindings/nvmem/vf610-ocotp.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt
Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt new file +20 -0
@@ -0,0 +1,20 @@ +On-Chip OTP Memory for Freescale Vybrid + +Required Properties: + compatible: + - "fsl,vf610-ocotp" for VF5xx/VF6xx + #address-cells : Should be 1 + #size-cells : Should be 1 + reg : Address and length of OTP controller registers + +Example for Vybrid VF5xx/VF6xx: + + ocotp: ocotp at 400a5000 { + compatible = "fsl,vf610-ocotp"; + #address-cells = <1>; + #size-cells = <1>; + reg = <0x400a5000 0xD00>; + clocks = <&clks VF610_CLK_OCOTP>; + clock-names = "ocotp"; + }; +
Signature · 1 line
2.5.0
Re: [PATCH v7 4/4] nvmem: Add DT binding documentation for Vybrid OCOTP driver
In reply to Srinivas KandagatlaHello,
Quoted 12 lines · Srinivas Kandagatla
Quoted 9 lines · Sanchayan Maity
Add the devicetree bindings for the Freescale Vybrid On-Chip OTP driver.
Signed-off-by Sanchayan Maity <[email protected]>--- .../devicetree/bindings/nvmem/vf610-ocotp.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+)create mode 100644
Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt
Quoted 16 lines
Quoted 6 lines
Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt new file +0
-0Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt line 8
Quoted 8 lines
Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt new file +8
-0@@ -0,0 +1,20 @@ +On-Chip OTP Memory for Freescale Vybrid + +Required Properties: + compatible: + - "fsl,vf610-ocotp" for VF5xx/VF6xx + #address-cells : Should be 1 + #size-cells : Should be 1 + reg : Address and length of OTP controller registersIs there a reason to not add clocks property in to the bindings?
An error on my part. Will fix with the next revision.
- Sanchayan.
Quoted 14 lines
Quoted 14 lines
Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt new file +12
-0+ +Example for Vybrid VF5xx/VF6xx: + + ocotp: ocotp at 400a5000 { + compatible = "fsl,vf610-ocotp"; + #address-cells = <1>; + #size-cells = <1>; + reg = <0x400a5000 0xD00>; + clocks = <&clks VF610_CLK_OCOTP>; + clock-names = "ocotp"; + }; +
Re: [PATCH v7 3/4] drivers: nvmem: Add Vybrid OCOTP support
In reply to Sanchayan MaityHi Sanchayan,
Could you add Greg to the "to list" so that we can request him to pick this via his tree.
Few nits, other than that driver looks good.
Quoted 16 lines · Sanchayan Maity
The patch adds support for the On Chip One Time Programmable Peripheral (OCOTP) on the Vybrid platform.
Signed-off-by Sanchayan Maity <[email protected]>--- drivers/nvmem/Kconfig | 10 ++ drivers/nvmem/Makefile | 2 + drivers/nvmem/vf610-ocotp.c | 297 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 309 insertions(+)create mode 100644
drivers/nvmem/vf610-ocotp.cdrivers/nvmem/Kconfig +0
-0
drivers/nvmem/Kconfig config NVMEM_IMX_OCOTP · line 52
Quoted 6 lines
drivers/nvmem/Kconfig +3
-0@@ -47,4 +47,14 @@ config NVMEM_IMX_OCOTP This driver can also be built as a module. If so, the module will be called nvmem-imx-ocotp. +config NVMEM_VF610_OCOTP + tristate "VF610_SoCs OCOTP support" + depends on SOC_VF610
You could also add COMPILE_TEST which will ensure that its compile checked.
Quoted 58 lines
drivers/nvmem/Kconfig +7
-0+ help + This is a driver for the 'OCOTP' peripheral available on Vybrid + devices like VF5xx and VF6xx. + + This driver can also be built as a module. If so, the module will + be called nvmem-vf610-ocotp. + endifdrivers/nvmem/Makefile +2
-0@@ -12,3 +12,5 @@ obj-$(CONFIG_NVMEM_SUNXI_SID) += nvmem_sunxi_sid.o nvmem_sunxi_sid-y := sunxi_sid.o obj-$(CONFIG_NVMEM_IMX_OCOTP) += nvmem-imx-ocotp.o nvmem-imx-ocotp-y := imx-ocotp.o +obj-$(CONFIG_NVMEM_VF610_OCOTP) += nvmem-vf610-ocotp.o +nvmem-vf610-ocotp-y := vf610-ocotp.odrivers/nvmem/vf610-ocotp.c new file +34
-0@@ -0,0 +1,297 @@ +/* +* Copyright (C) 2015 Toradex AG. +* +* Author: Sanchayan Maity <[email protected]> +* +* This program is free software; you can redistribute it and/or modify +* it under the terms of the GNU General Public License version 2 and +* only version 2 as published by the Free Software Foundation. +* +* This program is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +*/ + +#include <linux/clk.h> +#include <linux/delay.h> +#include <linux/device.h> +#include <linux/io.h> +#include <linux/module.h> +#include <linux/nvmem-provider.h> +#include <linux/of.h> +#include <linux/platform_device.h> +#include <linux/regmap.h> +#include <linux/slab.h> + +/* OCOTP Register Offsets */ +#define OCOTP_CTRL_REG 0x00 +#define OCOTP_CTRL_SET 0x04 +#define OCOTP_CTRL_CLR 0x08 +#define OCOTP_TIMING 0x10 +#define OCOTP_DATA 0x20 +#define OCOTP_READ_CTRL_REG 0x30 +#define OCOTP_READ_FUSE_DATA 0x40
drivers/nvmem/vf610-ocotp.c line 44
Quoted 10 lines
drivers/nvmem/vf610-ocotp.c new file +10
-0+ +/* OCOTP Register bits and masks */ +#define OCOTP_CTRL_WR_UNLOCK 16 +#define OCOTP_CTRL_WR_UNLOCK_KEY 0x3E77 +#define OCOTP_CTRL_WR_UNLOCK_MASK 0xFFFF0000 +#define OCOTP_CTRL_ADDR 0 +#define OCOTP_CTRL_ADDR_MASK 0x7F +#define OCOTP_CTRL_RELOAD_SHADOWS (0x1 << 10) +#define OCOTP_CTRL_ERROR (0x1 << 9) +#define OCOTP_CTRL_BUSY (0x1 << 8)
we can use BIT and GENMASK variants here for most of the defines.
Quoted 104 lines
drivers/nvmem/vf610-ocotp.c new file +104
-0+ +#define OCOTP_TIMING_STROBE_READ 16 +#define OCOTP_TIMING_STROBE_READ_MASK 0x003F0000 +#define OCOTP_TIMING_RELAX 12 +#define OCOTP_TIMING_RELAX_MASK 0x0000F000 +#define OCOTP_TIMING_STROBE_PROG 0 +#define OCOTP_TIMING_STROBE_PROG_MASK 0x00000FFF + +#define OCOTP_READ_CTRL_READ_FUSE 0x1 + +#define VF610_OCOTP_TIMEOUT 100000 + +#define BF (value, field) (((value) << field) & field##_MASK) + +#define DEF_RELAX 20 + +static const int base_to_fuse_addr_mappings[][2 ] = { + {0x400 ,0x00 }, + {0x410 ,0x01 }, + {0x420 ,0x02 }, + {0x450 ,0x05 }, + {0x4F0 ,0x0F }, + {0x600 ,0x20 }, + {0x610 ,0x21 }, + {0x620 ,0x22 }, + {0x630 ,0x23 }, + {0x640 ,0x24 }, + {0x650 ,0x25 }, + {0x660 ,0x26 }, + {0x670 ,0x27 }, + {0x6F0 ,0x2F }, + {0x880 ,0x38 }, + {0x890 ,0x39 }, + {0x8A0 ,0x3A }, + {0x8B0 ,0x3B }, + {0x8C0 ,0x3C }, + {0x8D0 ,0x3D }, + {0x8E0 ,0x3E }, + {0x8F0 ,0x3F }, + {0xC80 ,0x78 }, + {0xC90 ,0x79 }, + {0xCA0 ,0x7A }, + {0xCB0 ,0x7B }, + {0xCC0 ,0x7C }, + {0xCD0 ,0x7D }, + {0xCE0 ,0x7E }, + {0xCF0 ,0x7F }, +}; + +struct vf610_ocotp { +void __iomem *base; +struct clk *clk; +struct device *dev; +struct nvmem_device *nvmem; +int timing; +}; + +static int vf610_ocotp_wait_busy (void __iomem *base) +{ +int timeout =VF610_OCOTP_TIMEOUT ; + +while ((readl (base) &OCOTP_CTRL_BUSY ) && --timeout) +udelay (10 ); + +if (!timeout) { +writel (OCOTP_CTRL_ERROR , base +OCOTP_CTRL_CLR ); +return -ETIMEDOUT ; + } + +udelay (10 ); + +return 0 ; +} + +static int vf610_ocotp_calculate_timing (struct vf610_ocotp *ocotp_dev) +{ +u32 clk_rate; +u32 relax, strobe_read, strobe_prog; +u32 timing; + + clk_rate =clk_get_rate (ocotp_dev->clk); + +/* Refer section OTP read/write timing parameters in TRM */ + relax = clk_rate / (1000000000 /DEF_RELAX ) -1 ; + strobe_prog = clk_rate / (1000000000 /10000 ) +2 * (DEF_RELAX +1 ) -1 ; + strobe_read = clk_rate / (1000000000 /40 ) +2 * (DEF_RELAX +1 ) -1 ; + + timing =BF (relax,OCOTP_TIMING_RELAX ); + timing |=BF (strobe_read,OCOTP_TIMING_STROBE_READ ); + timing |=BF (strobe_prog,OCOTP_TIMING_STROBE_PROG ); + +return timing; +} + +static int vf610_get_fuse_address (int base_addr_offset) +{ +int i; + +for (i =0 ; i <ARRAY_SIZE (base_to_fuse_addr_mappings); i++) { +if (base_to_fuse_addr_mappings[i][0 ] == base_addr_offset) +return base_to_fuse_addr_mappings[i][1 ]; + } + +return -EINVAL ;
drivers/nvmem/vf610-ocotp.c line 158
Quoted 10 lines
drivers/nvmem/vf610-ocotp.c new file +10
-0+} + +static int vf610_ocotp_write (void *context,const void *data,size_t count) +{ +return 0 ; +} + +static int vf610_ocotp_read (void *context, +const void *off,size_t reg_size, +void *val,size_t val_size)
Align it to the braces.
Quoted 53 lines
drivers/nvmem/vf610-ocotp.c new file +53
-0+{ +struct vf610_ocotp *ocotp = context; +unsigned int offset = *(u32 *)off; +u32 reg, *buf = val; +int fuse_addr; +int ret; + +while (val_size >0 ) { + fuse_addr =vf610_get_fuse_address (offset); +if (fuse_addr >0 ) { +writel (ocotp->timing, ocotp->base +OCOTP_TIMING ); + ret =vf610_ocotp_wait_busy (ocotp->base +OCOTP_CTRL_REG ); +if (ret) +return ret; + + reg =readl (ocotp->base +OCOTP_CTRL_REG ); + reg &= ~OCOTP_CTRL_ADDR_MASK ; + reg &= ~OCOTP_CTRL_WR_UNLOCK_MASK ; + reg |=BF (fuse_addr,OCOTP_CTRL_ADDR ); +writel (reg, ocotp->base +OCOTP_CTRL_REG ); + +writel (OCOTP_READ_CTRL_READ_FUSE , + ocotp->base +OCOTP_READ_CTRL_REG ); + ret =vf610_ocotp_wait_busy (ocotp->base +OCOTP_CTRL_REG ); +if (ret) +return ret; + +if (readl (ocotp->base) &OCOTP_CTRL_ERROR ) { +dev_dbg (ocotp->dev,"Error reading from fuse address %x\n" , + fuse_addr); +writel (OCOTP_CTRL_ERROR , ocotp->base +OCOTP_CTRL_CLR ); + } + +/* +* In case of error, we do not abort and expect to read +* 0xBADABADA as mentioned by the TRM. We just read this +* value and return. +*/ + *buf =readl (ocotp->base +OCOTP_READ_FUSE_DATA ); + }else { + *buf =0 ; + } + + buf++; + val_size--; + offset += reg_size; + } + +return 0 ; +} + +static struct regmap_bus vf610_ocotp_bus = { + .read = vf610_ocotp_read,
drivers/nvmem/vf610-ocotp.c line 221
Quoted 10 lines
drivers/nvmem/vf610-ocotp.c new file +10
-0+ .write = vf610_ocotp_write, + .reg_format_endian_default = REGMAP_ENDIAN_NATIVE, + .val_format_endian_default = REGMAP_ENDIAN_NATIVE, +}; + +static struct regmap_config ocotp_regmap_config = { + .reg_bits =32 , + .val_bits =32 , + .reg_stride =4 , + .max_register =0xCF0 ,
Cant we get this info from the resource_size() ?
Quoted 77 lines
drivers/nvmem/vf610-ocotp.c new file +76
-0+}; + +static struct nvmem_config ocotp_config = { + .name ="ocotp" , + .owner =THIS_MODULE , +}; + +static const struct of_device_id ocotp_of_match[] = { + { .compatible ="fsl,vf610-ocotp" , }, + {/* sentinel */ }, +}; +MODULE_DEVICE_TABLE (of, ocotp_of_match); + +static int vf610_ocotp_remove (struct platform_device *pdev) +{ +struct vf610_ocotp *ocotp_dev =platform_get_drvdata (pdev); + +return nvmem_unregister (ocotp_dev->nvmem); +} + +static int vf610_ocotp_probe (struct platform_device *pdev) +{ +struct device *dev = &pdev->dev; +struct resource *res; +struct regmap *regmap; +struct vf610_ocotp *ocotp_dev; + + ocotp_dev =devm_kzalloc (&pdev->dev, +sizeof (struct vf610_ocotp ),GFP_KERNEL ); +if (!ocotp_dev) +return -ENOMEM ; + + res =platform_get_resource (pdev,IORESOURCE_MEM ,0 ); + ocotp_dev->base =devm_ioremap_resource (dev, res); +if (IS_ERR (ocotp_dev->base)) +return PTR_ERR (ocotp_dev->base); + + ocotp_dev->clk =devm_clk_get (dev,"ocotp" ); +if (IS_ERR (ocotp_dev->clk)) { +dev_err (dev,"failed getting clock, err = %ld\n" , +PTR_ERR (ocotp_dev->clk)); +return PTR_ERR (ocotp_dev->clk); + } + + regmap =devm_regmap_init (dev, + &vf610_ocotp_bus, ocotp_dev, &ocotp_regmap_config); +if (IS_ERR (regmap)) { +dev_err (dev,"regmap init failed\n" ); +return PTR_ERR (regmap); + } + ocotp_config.dev = dev; + + ocotp_dev->nvmem =nvmem_register (&ocotp_config); +if (IS_ERR (ocotp_dev->nvmem)) +return PTR_ERR (ocotp_dev->nvmem); + + ocotp_dev->dev = dev; +platform_set_drvdata (pdev, ocotp_dev); + + ocotp_dev->timing =vf610_ocotp_calculate_timing (ocotp_dev); + +return 0 ; +} + +static struct platform_driver vf610_ocotp_driver = { + .probe = vf610_ocotp_probe, + .remove = vf610_ocotp_remove, + .driver = { + .name ="vf610-ocotp" , + .of_match_table = ocotp_of_match, + }, +}; +module_platform_driver (vf610_ocotp_driver); +MODULE_AUTHOR ("Sanchayan Maity <[email protected]>" ); +MODULE_DESCRIPTION ("Vybrid OCOTP driver" ); +MODULE_LICENSE ("GPL v2" );
Re: [PATCH v7 4/4] nvmem: Add DT binding documentation for Vybrid OCOTP driver
In reply to Sanchayan MaityQuoted 15 lines · Sanchayan Maity
Add the devicetree bindings for the Freescale Vybrid On-Chip OTP driver.
Signed-off-by Sanchayan Maity <[email protected]>--- .../devicetree/bindings/nvmem/vf610-ocotp.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+)create mode 100644
Documentation/devicetree/bindings/nvmem/vf610-ocotp.txtDocumentation/devicetree/bindings/nvmem/vf610-ocotp.txt new file +0
-0
Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt line 8
Quoted 8 lines
Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt new file +8
-0@@ -0,0 +1,20 @@ +On-Chip OTP Memory for Freescale Vybrid + +Required Properties: + compatible: + - "fsl,vf610-ocotp" for VF5xx/VF6xx + #address-cells : Should be 1 + #size-cells : Should be 1 + reg : Address and length of OTP controller registers
Is there a reason to not add clocks property in to the bindings?
Quoted 13 lines
Documentation/devicetree/bindings/nvmem/vf610-ocotp.txt new file +12
-0+ +Example for Vybrid VF5xx/VF6xx: + + ocotp: ocotp at 400a5000 { + compatible = "fsl,vf610-ocotp"; + #address-cells = <1>; + #size-cells = <1>; + reg = <0x400a5000 0xD00>; + clocks = <&clks VF610_CLK_OCOTP>; + clock-names = "ocotp"; + }; +
Re: [PATCH v7 3/4] drivers: nvmem: Add Vybrid OCOTP support
In reply to Srinivas KandagatlaHello,
Quoted 5 lines · Srinivas Kandagatla
Hi Sanchayan,
Could you add Greg to the "to list" so that we can request him to pick this via his tree.
Will add Greg in cc with the next revision.
Quoted 25 lines
Few nits, other than that driver looks good.
Quoted 19 lines · Sanchayan Maity
The patch adds support for the On Chip One Time Programmable Peripheral (OCOTP) on the Vybrid platform.
Signed-off-by Sanchayan Maity <[email protected]>--- drivers/nvmem/Kconfig | 10 ++ drivers/nvmem/Makefile | 2 + drivers/nvmem/vf610-ocotp.c | 297 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 309 insertions(+)create mode 100644
drivers/nvmem/vf610-ocotp.cdrivers/nvmem/Kconfig +0
-0@@ -47,4 +47,14 @@ config NVMEM_IMX_OCOTP This driver can also be built as a module. If so, the module will be called nvmem-imx-ocotp.
Quoted 4 lines
drivers/nvmem/Kconfig config NVMEM_IMX_OCOTP · line 52
Quoted 3 lines
drivers/nvmem/Kconfig +3
-0+config NVMEM_VF610_OCOTP + tristate "VF610_SoCs OCOTP support" + depends on SOC_VF610You could also add
COMPILE_TESTwhich will ensure that its compile checked.
Ok.
Quoted 62 lines
Quoted 62 lines
drivers/nvmem/Kconfig +7
-0+ help + This is a driver for the 'OCOTP' peripheral available on Vybrid + devices like VF5xx and VF6xx. + + This driver can also be built as a module. If so, the module will + be called nvmem-vf610-ocotp. + endifdrivers/nvmem/Makefile +2
-0@@ -12,3 +12,5 @@ obj-$(CONFIG_NVMEM_SUNXI_SID) += nvmem_sunxi_sid.o nvmem_sunxi_sid-y := sunxi_sid.o obj-$(CONFIG_NVMEM_IMX_OCOTP) += nvmem-imx-ocotp.o nvmem-imx-ocotp-y := imx-ocotp.o +obj-$(CONFIG_NVMEM_VF610_OCOTP) += nvmem-vf610-ocotp.o +nvmem-vf610-ocotp-y := vf610-ocotp.odrivers/nvmem/vf610-ocotp.c new file +38
-0@@ -0,0 +1,297 @@ +/* +* Copyright (C) 2015 Toradex AG. +* +* Author: Sanchayan Maity <[email protected]> +* +* This program is free software; you can redistribute it and/or modify +* it under the terms of the GNU General Public License version 2 and +* only version 2 as published by the Free Software Foundation. +* +* This program is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +*/ + +#include <linux/clk.h> +#include <linux/delay.h> +#include <linux/device.h> +#include <linux/io.h> +#include <linux/module.h> +#include <linux/nvmem-provider.h> +#include <linux/of.h> +#include <linux/platform_device.h> +#include <linux/regmap.h> +#include <linux/slab.h> + +/* OCOTP Register Offsets */ +#define OCOTP_CTRL_REG 0x00 +#define OCOTP_CTRL_SET 0x04 +#define OCOTP_CTRL_CLR 0x08 +#define OCOTP_TIMING 0x10 +#define OCOTP_DATA 0x20 +#define OCOTP_READ_CTRL_REG 0x30 +#define OCOTP_READ_FUSE_DATA 0x40 + +/* OCOTP Register bits and masks */ +#define OCOTP_CTRL_WR_UNLOCK 16 +#define OCOTP_CTRL_WR_UNLOCK_KEY 0x3E77
Quoted 8 lines
drivers/nvmem/vf610-ocotp.c line 44
Quoted 6 lines
drivers/nvmem/vf610-ocotp.c new file +6
-0+#define OCOTP_CTRL_WR_UNLOCK_MASK 0xFFFF0000 +#define OCOTP_CTRL_ADDR 0 +#define OCOTP_CTRL_ADDR_MASK 0x7F +#define OCOTP_CTRL_RELOAD_SHADOWS (0x1 << 10) +#define OCOTP_CTRL_ERROR (0x1 << 9) +#define OCOTP_CTRL_BUSY (0x1 << 8)we can use BIT and GENMASK variants here for most of the defines.
Ok.
Quoted 107 lines
Quoted 107 lines
drivers/nvmem/vf610-ocotp.c new file +107
-0+ +#define OCOTP_TIMING_STROBE_READ 16 +#define OCOTP_TIMING_STROBE_READ_MASK 0x003F0000 +#define OCOTP_TIMING_RELAX 12 +#define OCOTP_TIMING_RELAX_MASK 0x0000F000 +#define OCOTP_TIMING_STROBE_PROG 0 +#define OCOTP_TIMING_STROBE_PROG_MASK 0x00000FFF + +#define OCOTP_READ_CTRL_READ_FUSE 0x1 + +#define VF610_OCOTP_TIMEOUT 100000 + +#define BF (value, field) (((value) << field) & field##_MASK) + +#define DEF_RELAX 20 + +static const int base_to_fuse_addr_mappings[][2 ] = { + {0x400 ,0x00 }, + {0x410 ,0x01 }, + {0x420 ,0x02 }, + {0x450 ,0x05 }, + {0x4F0 ,0x0F }, + {0x600 ,0x20 }, + {0x610 ,0x21 }, + {0x620 ,0x22 }, + {0x630 ,0x23 }, + {0x640 ,0x24 }, + {0x650 ,0x25 }, + {0x660 ,0x26 }, + {0x670 ,0x27 }, + {0x6F0 ,0x2F }, + {0x880 ,0x38 }, + {0x890 ,0x39 }, + {0x8A0 ,0x3A }, + {0x8B0 ,0x3B }, + {0x8C0 ,0x3C }, + {0x8D0 ,0x3D }, + {0x8E0 ,0x3E }, + {0x8F0 ,0x3F }, + {0xC80 ,0x78 }, + {0xC90 ,0x79 }, + {0xCA0 ,0x7A }, + {0xCB0 ,0x7B }, + {0xCC0 ,0x7C }, + {0xCD0 ,0x7D }, + {0xCE0 ,0x7E }, + {0xCF0 ,0x7F }, +}; + +struct vf610_ocotp { +void __iomem *base; +struct clk *clk; +struct device *dev; +struct nvmem_device *nvmem; +int timing; +}; + +static int vf610_ocotp_wait_busy (void __iomem *base) +{ +int timeout =VF610_OCOTP_TIMEOUT ; + +while ((readl (base) &OCOTP_CTRL_BUSY ) && --timeout) +udelay (10 ); + +if (!timeout) { +writel (OCOTP_CTRL_ERROR , base +OCOTP_CTRL_CLR ); +return -ETIMEDOUT ; + } + +udelay (10 ); + +return 0 ; +} + +static int vf610_ocotp_calculate_timing (struct vf610_ocotp *ocotp_dev) +{ +u32 clk_rate; +u32 relax, strobe_read, strobe_prog; +u32 timing; + + clk_rate =clk_get_rate (ocotp_dev->clk); + +/* Refer section OTP read/write timing parameters in TRM */ + relax = clk_rate / (1000000000 /DEF_RELAX ) -1 ; + strobe_prog = clk_rate / (1000000000 /10000 ) +2 * (DEF_RELAX +1 ) -1 ; + strobe_read = clk_rate / (1000000000 /40 ) +2 * (DEF_RELAX +1 ) -1 ; + + timing =BF (relax,OCOTP_TIMING_RELAX ); + timing |=BF (strobe_read,OCOTP_TIMING_STROBE_READ ); + timing |=BF (strobe_prog,OCOTP_TIMING_STROBE_PROG ); + +return timing; +} + +static int vf610_get_fuse_address (int base_addr_offset) +{ +int i; + +for (i =0 ; i <ARRAY_SIZE (base_to_fuse_addr_mappings); i++) { +if (base_to_fuse_addr_mappings[i][0 ] == base_addr_offset) +return base_to_fuse_addr_mappings[i][1 ]; + } + +return -EINVAL ; +} + +static int vf610_ocotp_write (void *context,const void *data,size_t count)
Quoted 8 lines
drivers/nvmem/vf610-ocotp.c line 158
Quoted 7 lines
drivers/nvmem/vf610-ocotp.c new file +7
-0+{ +return 0 ; +} + +static int vf610_ocotp_read (void *context, +const void *off,size_t reg_size, +void *val,size_t val_size)Align it to the braces.
Ok.
Quoted 56 lines
Quoted 56 lines
drivers/nvmem/vf610-ocotp.c new file +56
-0+{ +struct vf610_ocotp *ocotp = context; +unsigned int offset = *(u32 *)off; +u32 reg, *buf = val; +int fuse_addr; +int ret; + +while (val_size >0 ) { + fuse_addr =vf610_get_fuse_address (offset); +if (fuse_addr >0 ) { +writel (ocotp->timing, ocotp->base +OCOTP_TIMING ); + ret =vf610_ocotp_wait_busy (ocotp->base +OCOTP_CTRL_REG ); +if (ret) +return ret; + + reg =readl (ocotp->base +OCOTP_CTRL_REG ); + reg &= ~OCOTP_CTRL_ADDR_MASK ; + reg &= ~OCOTP_CTRL_WR_UNLOCK_MASK ; + reg |=BF (fuse_addr,OCOTP_CTRL_ADDR ); +writel (reg, ocotp->base +OCOTP_CTRL_REG ); + +writel (OCOTP_READ_CTRL_READ_FUSE , + ocotp->base +OCOTP_READ_CTRL_REG ); + ret =vf610_ocotp_wait_busy (ocotp->base +OCOTP_CTRL_REG ); +if (ret) +return ret; + +if (readl (ocotp->base) &OCOTP_CTRL_ERROR ) { +dev_dbg (ocotp->dev,"Error reading from fuse address %x\n" , + fuse_addr); +writel (OCOTP_CTRL_ERROR , ocotp->base +OCOTP_CTRL_CLR ); + } + +/* +* In case of error, we do not abort and expect to read +* 0xBADABADA as mentioned by the TRM. We just read this +* value and return. +*/ + *buf =readl (ocotp->base +OCOTP_READ_FUSE_DATA ); + }else { + *buf =0 ; + } + + buf++; + val_size--; + offset += reg_size; + } + +return 0 ; +} + +static struct regmap_bus vf610_ocotp_bus = { + .read = vf610_ocotp_read, + .write = vf610_ocotp_write, + .reg_format_endian_default =REGMAP_ENDIAN_NATIVE , + .val_format_endian_default =REGMAP_ENDIAN_NATIVE ,
Quoted 8 lines
drivers/nvmem/vf610-ocotp.c line 221
Quoted 7 lines
drivers/nvmem/vf610-ocotp.c new file +7
-0+}; + +static struct regmap_config ocotp_regmap_config = { + .reg_bits =32 , + .val_bits =32 , + .reg_stride =4 , + .max_register =0xCF0 ,Cant we get this info from the
resource_size()?
Yes we can. I will change to that.
Thanks for the review.
- Sanchayan.
Quoted 77 lines
Quoted 77 lines
drivers/nvmem/vf610-ocotp.c new file +76
-0+}; + +static struct nvmem_config ocotp_config = { + .name ="ocotp" , + .owner =THIS_MODULE , +}; + +static const struct of_device_id ocotp_of_match[] = { + { .compatible ="fsl,vf610-ocotp" , }, + {/* sentinel */ }, +}; +MODULE_DEVICE_TABLE (of, ocotp_of_match); + +static int vf610_ocotp_remove (struct platform_device *pdev) +{ +struct vf610_ocotp *ocotp_dev =platform_get_drvdata (pdev); + +return nvmem_unregister (ocotp_dev->nvmem); +} + +static int vf610_ocotp_probe (struct platform_device *pdev) +{ +struct device *dev = &pdev->dev; +struct resource *res; +struct regmap *regmap; +struct vf610_ocotp *ocotp_dev; + + ocotp_dev =devm_kzalloc (&pdev->dev, +sizeof (struct vf610_ocotp ),GFP_KERNEL ); +if (!ocotp_dev) +return -ENOMEM ; + + res =platform_get_resource (pdev,IORESOURCE_MEM ,0 ); + ocotp_dev->base =devm_ioremap_resource (dev, res); +if (IS_ERR (ocotp_dev->base)) +return PTR_ERR (ocotp_dev->base); + + ocotp_dev->clk =devm_clk_get (dev,"ocotp" ); +if (IS_ERR (ocotp_dev->clk)) { +dev_err (dev,"failed getting clock, err = %ld\n" , +PTR_ERR (ocotp_dev->clk)); +return PTR_ERR (ocotp_dev->clk); + } + + regmap =devm_regmap_init (dev, + &vf610_ocotp_bus, ocotp_dev, &ocotp_regmap_config); +if (IS_ERR (regmap)) { +dev_err (dev,"regmap init failed\n" ); +return PTR_ERR (regmap); + } + ocotp_config.dev = dev; + + ocotp_dev->nvmem =nvmem_register (&ocotp_config); +if (IS_ERR (ocotp_dev->nvmem)) +return PTR_ERR (ocotp_dev->nvmem); + + ocotp_dev->dev = dev; +platform_set_drvdata (pdev, ocotp_dev); + + ocotp_dev->timing =vf610_ocotp_calculate_timing (ocotp_dev); + +return 0 ; +} + +static struct platform_driver vf610_ocotp_driver = { + .probe = vf610_ocotp_probe, + .remove = vf610_ocotp_remove, + .driver = { + .name ="vf610-ocotp" , + .of_match_table = ocotp_of_match, + }, +}; +module_platform_driver (vf610_ocotp_driver); +MODULE_AUTHOR ("Sanchayan Maity <[email protected]>" ); +MODULE_DESCRIPTION ("Vybrid OCOTP driver" ); +MODULE_LICENSE ("GPL v2" );