1 // SPDX-License-Identifier: GPL-2.0
3 * STM32 Factory-programmed memory read access driver
5 * Copyright (C) 2017, STMicroelectronics - All Rights Reserved
6 * Author: Fabrice Gasnier <fabrice.gasnier@st.com> for STMicroelectronics.
9 #include <linux/arm-smccc.h>
11 #include <linux/module.h>
12 #include <linux/nvmem-provider.h>
14 #include <linux/platform_device.h>
15 #include <linux/property.h>
16 #include <linux/tee_drv.h>
18 #include "stm32-bsec-optee-ta.h"
20 /* BSEC secure service access from non-secure */
21 #define STM32_SMC_BSEC 0x82001003
22 #define STM32_SMC_READ_SHADOW 0x01
23 #define STM32_SMC_PROG_OTP 0x02
24 #define STM32_SMC_WRITE_SHADOW 0x03
25 #define STM32_SMC_READ_OTP 0x04
27 /* shadow registers offset */
28 #define STM32MP15_BSEC_DATA0 0x200
30 struct stm32_romem_cfg {
36 struct stm32_romem_priv {
38 struct nvmem_config cfg;
40 struct tee_context *ctx;
43 static int stm32_romem_read(void *context, unsigned int offset, void *buf,
46 struct stm32_romem_priv *priv = context;
50 for (i = offset; i < offset + bytes; i++)
51 *buf8++ = readb_relaxed(priv->base + i);
56 static int stm32_bsec_smc(u8 op, u32 otp, u32 data, u32 *result)
58 #if IS_ENABLED(CONFIG_HAVE_ARM_SMCCC)
59 struct arm_smccc_res res;
61 arm_smccc_smc(STM32_SMC_BSEC, op, otp, data, 0, 0, 0, 0, &res);
66 *result = (u32)res.a1;
74 static int stm32_bsec_read(void *context, unsigned int offset, void *buf,
77 struct stm32_romem_priv *priv = context;
78 struct device *dev = priv->cfg.dev;
79 u32 roffset, rbytes, val;
80 u8 *buf8 = buf, *val8 = (u8 *)&val;
81 int i, j = 0, ret, skip_bytes, size;
83 /* Round unaligned access to 32-bits */
84 roffset = rounddown(offset, 4);
85 skip_bytes = offset & 0x3;
86 rbytes = roundup(bytes + skip_bytes, 4);
88 if (roffset + rbytes > priv->cfg.size)
91 for (i = roffset; (i < roffset + rbytes); i += 4) {
94 if (otp < priv->lower) {
95 /* read lower data from shadow registers */
97 priv->base + STM32MP15_BSEC_DATA0 + i);
99 ret = stm32_bsec_smc(STM32_SMC_READ_SHADOW, otp, 0,
102 dev_err(dev, "Can't read data%d (%d)\n", otp,
107 /* skip first bytes in case of unaligned read */
109 size = min(bytes, (size_t)(4 - skip_bytes));
111 size = min(bytes, (size_t)4);
112 memcpy(&buf8[j], &val8[skip_bytes], size);
121 static int stm32_bsec_write(void *context, unsigned int offset, void *buf,
124 struct stm32_romem_priv *priv = context;
125 struct device *dev = priv->cfg.dev;
129 /* Allow only writing complete 32-bits aligned words */
130 if ((bytes % 4) || (offset % 4))
133 for (i = offset; i < offset + bytes; i += 4) {
134 ret = stm32_bsec_smc(STM32_SMC_PROG_OTP, i >> 2, *buf32++,
137 dev_err(dev, "Can't write data%d (%d)\n", i >> 2, ret);
142 if (offset + bytes >= priv->lower * 4)
143 dev_warn(dev, "Update of upper OTPs with ECC protection (word programming, only once)\n");
148 static int stm32_bsec_pta_read(void *context, unsigned int offset, void *buf,
151 struct stm32_romem_priv *priv = context;
153 return stm32_bsec_optee_ta_read(priv->ctx, offset, buf, bytes);
156 static int stm32_bsec_pta_write(void *context, unsigned int offset, void *buf,
159 struct stm32_romem_priv *priv = context;
161 return stm32_bsec_optee_ta_write(priv->ctx, priv->lower, offset, buf, bytes);
164 static bool stm32_bsec_smc_check(void)
169 /* check that the OP-TEE support the BSEC SMC (legacy mode) */
170 ret = stm32_bsec_smc(STM32_SMC_READ_SHADOW, 0, 0, &val);
175 static bool optee_presence_check(void)
177 struct device_node *np;
178 bool tee_detected = false;
180 /* check that the OP-TEE node is present and available. */
181 np = of_find_compatible_node(NULL, NULL, "linaro,optee-tz");
182 if (np && of_device_is_available(np))
189 static int stm32_romem_probe(struct platform_device *pdev)
191 const struct stm32_romem_cfg *cfg;
192 struct device *dev = &pdev->dev;
193 struct stm32_romem_priv *priv;
194 struct resource *res;
197 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
201 priv->base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
202 if (IS_ERR(priv->base))
203 return PTR_ERR(priv->base);
205 priv->cfg.name = "stm32-romem";
206 priv->cfg.word_size = 1;
207 priv->cfg.stride = 1;
209 priv->cfg.priv = priv;
210 priv->cfg.owner = THIS_MODULE;
211 priv->cfg.type = NVMEM_TYPE_OTP;
212 priv->cfg.add_legacy_fixed_of_cells = true;
216 cfg = device_get_match_data(dev);
218 priv->cfg.read_only = true;
219 priv->cfg.size = resource_size(res);
220 priv->cfg.reg_read = stm32_romem_read;
222 priv->cfg.size = cfg->size;
223 priv->lower = cfg->lower;
224 if (cfg->ta || optee_presence_check()) {
225 rc = stm32_bsec_optee_ta_open(&priv->ctx);
227 /* wait for OP-TEE client driver to be up and ready */
228 if (rc == -EPROBE_DEFER)
229 return -EPROBE_DEFER;
230 /* BSEC PTA is required or SMC not supported */
231 if (cfg->ta || !stm32_bsec_smc_check())
236 rc = devm_add_action_or_reset(dev, stm32_bsec_optee_ta_close, priv->ctx);
238 dev_err(dev, "devm_add_action_or_reset() failed (%d)\n", rc);
241 priv->cfg.reg_read = stm32_bsec_pta_read;
242 priv->cfg.reg_write = stm32_bsec_pta_write;
244 priv->cfg.reg_read = stm32_bsec_read;
245 priv->cfg.reg_write = stm32_bsec_write;
249 return PTR_ERR_OR_ZERO(devm_nvmem_register(dev, &priv->cfg));
253 * STM32MP15/13 BSEC OTP regions: 4096 OTP bits (with 3072 effective bits)
254 * => 96 x 32-bits data words
255 * - Lower: 1K bits, 2:1 redundancy, incremental bit programming
256 * => 32 (x 32-bits) lower shadow registers = words 0 to 31
257 * - Upper: 2K bits, ECC protection, word programming only
258 * => 64 (x 32-bits) = words 32 to 95
260 static const struct stm32_romem_cfg stm32mp15_bsec_cfg = {
266 static const struct stm32_romem_cfg stm32mp13_bsec_cfg = {
273 * STM32MP25 BSEC OTP: 3 regions of 32-bits data words
274 * lower OTP (OTP0 to OTP127), bitwise (1-bit) programmable
275 * mid OTP (OTP128 to OTP255), bulk (32-bit) programmable
276 * upper OTP (OTP256 to OTP383), bulk (32-bit) programmable
277 * but no access to HWKEY and ECIES key: limited at OTP367
279 static const struct stm32_romem_cfg stm32mp25_bsec_cfg = {
285 static const struct of_device_id stm32_romem_of_match[] __maybe_unused = {
286 { .compatible = "st,stm32f4-otp", }, {
287 .compatible = "st,stm32mp15-bsec",
288 .data = (void *)&stm32mp15_bsec_cfg,
290 .compatible = "st,stm32mp13-bsec",
291 .data = (void *)&stm32mp13_bsec_cfg,
293 .compatible = "st,stm32mp25-bsec",
294 .data = (void *)&stm32mp25_bsec_cfg,
298 MODULE_DEVICE_TABLE(of, stm32_romem_of_match);
300 static struct platform_driver stm32_romem_driver = {
301 .probe = stm32_romem_probe,
303 .name = "stm32-romem",
304 .of_match_table = of_match_ptr(stm32_romem_of_match),
307 module_platform_driver(stm32_romem_driver);
309 MODULE_AUTHOR("Fabrice Gasnier <fabrice.gasnier@st.com>");
310 MODULE_DESCRIPTION("STMicroelectronics STM32 RO-MEM");
311 MODULE_ALIAS("platform:nvmem-stm32-romem");
312 MODULE_LICENSE("GPL v2");