802-v5.12-0003-nvmem-Add-driver-to-expose-reserved-memory-as-nvmem.patch 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. From 5a3fa75a4d9cb6bcfc9081ef224a4cdcd4b3eafe Mon Sep 17 00:00:00 2001
  2. From: Nicolas Saenz Julienne <[email protected]>
  3. Date: Fri, 29 Jan 2021 17:14:29 +0000
  4. Subject: [PATCH] nvmem: Add driver to expose reserved memory as nvmem
  5. Firmware/co-processors might use reserved memory areas in order to pass
  6. data stemming from an nvmem device otherwise non accessible to Linux.
  7. For example an EEPROM memory only physically accessible to firmware, or
  8. data only accessible early at boot time.
  9. In order to expose this data to other drivers and user-space, the driver
  10. models the reserved memory area as an nvmem device.
  11. Tested-by: Tim Gover <[email protected]>
  12. Reviewed-by: Rob Herring <[email protected]>
  13. Signed-off-by: Nicolas Saenz Julienne <[email protected]>
  14. Signed-off-by: Srinivas Kandagatla <[email protected]>
  15. Link: https://lore.kernel.org/r/[email protected]
  16. Signed-off-by: Greg Kroah-Hartman <[email protected]>
  17. ---
  18. drivers/nvmem/Kconfig | 8 ++++
  19. drivers/nvmem/Makefile | 2 +
  20. drivers/nvmem/rmem.c | 97 ++++++++++++++++++++++++++++++++++++++++++
  21. drivers/of/platform.c | 1 +
  22. 4 files changed, 108 insertions(+)
  23. create mode 100644 drivers/nvmem/rmem.c
  24. --- a/drivers/nvmem/Kconfig
  25. +++ b/drivers/nvmem/Kconfig
  26. @@ -270,4 +270,12 @@ config SPRD_EFUSE
  27. This driver can also be built as a module. If so, the module
  28. will be called nvmem-sprd-efuse.
  29. +config NVMEM_RMEM
  30. + tristate "Reserved Memory Based Driver Support"
  31. + help
  32. + This drivers maps reserved memory into an nvmem device. It might be
  33. + useful to expose information left by firmware in memory.
  34. +
  35. + This driver can also be built as a module. If so, the module
  36. + will be called nvmem-rmem.
  37. endif
  38. --- a/drivers/nvmem/Makefile
  39. +++ b/drivers/nvmem/Makefile
  40. @@ -55,3 +55,5 @@ obj-$(CONFIG_NVMEM_ZYNQMP) += nvmem_zynq
  41. nvmem_zynqmp_nvmem-y := zynqmp_nvmem.o
  42. obj-$(CONFIG_SPRD_EFUSE) += nvmem_sprd_efuse.o
  43. nvmem_sprd_efuse-y := sprd-efuse.o
  44. +obj-$(CONFIG_NVMEM_RMEM) += nvmem-rmem.o
  45. +nvmem-rmem-y := rmem.o
  46. --- /dev/null
  47. +++ b/drivers/nvmem/rmem.c
  48. @@ -0,0 +1,97 @@
  49. +// SPDX-License-Identifier: GPL-2.0+
  50. +/*
  51. + * Copyright (C) 2020 Nicolas Saenz Julienne <[email protected]>
  52. + */
  53. +
  54. +#include <linux/io.h>
  55. +#include <linux/module.h>
  56. +#include <linux/nvmem-provider.h>
  57. +#include <linux/of_reserved_mem.h>
  58. +#include <linux/platform_device.h>
  59. +
  60. +struct rmem {
  61. + struct device *dev;
  62. + struct nvmem_device *nvmem;
  63. + struct reserved_mem *mem;
  64. +
  65. + phys_addr_t size;
  66. +};
  67. +
  68. +static int rmem_read(void *context, unsigned int offset,
  69. + void *val, size_t bytes)
  70. +{
  71. + struct rmem *priv = context;
  72. + size_t available = priv->mem->size;
  73. + loff_t off = offset;
  74. + void *addr;
  75. + int count;
  76. +
  77. + /*
  78. + * Only map the reserved memory at this point to avoid potential rogue
  79. + * kernel threads inadvertently modifying it. Based on the current
  80. + * uses-cases for this driver, the performance hit isn't a concern.
  81. + * Nor is likely to be, given the nature of the subsystem. Most nvmem
  82. + * devices operate over slow buses to begin with.
  83. + *
  84. + * An alternative would be setting the memory as RO, set_memory_ro(),
  85. + * but as of Dec 2020 this isn't possible on arm64.
  86. + */
  87. + addr = memremap(priv->mem->base, available, MEMREMAP_WB);
  88. + if (IS_ERR(addr)) {
  89. + dev_err(priv->dev, "Failed to remap memory region\n");
  90. + return PTR_ERR(addr);
  91. + }
  92. +
  93. + count = memory_read_from_buffer(val, bytes, &off, addr, available);
  94. +
  95. + memunmap(addr);
  96. +
  97. + return count;
  98. +}
  99. +
  100. +static int rmem_probe(struct platform_device *pdev)
  101. +{
  102. + struct nvmem_config config = { };
  103. + struct device *dev = &pdev->dev;
  104. + struct reserved_mem *mem;
  105. + struct rmem *priv;
  106. +
  107. + priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
  108. + if (!priv)
  109. + return -ENOMEM;
  110. + priv->dev = dev;
  111. +
  112. + mem = of_reserved_mem_lookup(dev->of_node);
  113. + if (!mem) {
  114. + dev_err(dev, "Failed to lookup reserved memory\n");
  115. + return -EINVAL;
  116. + }
  117. + priv->mem = mem;
  118. +
  119. + config.dev = dev;
  120. + config.priv = priv;
  121. + config.name = "rmem";
  122. + config.size = mem->size;
  123. + config.reg_read = rmem_read;
  124. +
  125. + return PTR_ERR_OR_ZERO(devm_nvmem_register(dev, &config));
  126. +}
  127. +
  128. +static const struct of_device_id rmem_match[] = {
  129. + { .compatible = "nvmem-rmem", },
  130. + { /* sentinel */ },
  131. +};
  132. +MODULE_DEVICE_TABLE(of, rmem_match);
  133. +
  134. +static struct platform_driver rmem_driver = {
  135. + .probe = rmem_probe,
  136. + .driver = {
  137. + .name = "rmem",
  138. + .of_match_table = rmem_match,
  139. + },
  140. +};
  141. +module_platform_driver(rmem_driver);
  142. +
  143. +MODULE_AUTHOR("Nicolas Saenz Julienne <[email protected]>");
  144. +MODULE_DESCRIPTION("Reserved Memory Based nvmem Driver");
  145. +MODULE_LICENSE("GPL");
  146. --- a/drivers/of/platform.c
  147. +++ b/drivers/of/platform.c
  148. @@ -511,6 +511,7 @@ static const struct of_device_id reserve
  149. { .compatible = "qcom,rmtfs-mem" },
  150. { .compatible = "qcom,cmd-db" },
  151. { .compatible = "ramoops" },
  152. + { .compatible = "nvmem-rmem" },
  153. {}
  154. };