drivers/remoteproc/stm32_copro.c

   1 // SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
   2 /*
   3  * Copyright (C) 2019, STMicroelectronics - All Rights Reserved
   4  */
   5 #define pr_fmt(fmt) "%s: " fmt, __func__
   6 #include <common.h>
   7 #include <dm.h>
   8 #include <errno.h>
   9 #include <fdtdec.h>
  10 #include <regmap.h>
  11 #include <remoteproc.h>
  12 #include <reset.h>
  13 #include <syscon.h>
  14 #include <asm/io.h>
  15
  16 #define RCC_GCR_HOLD_BOOT       0
  17 #define RCC_GCR_RELEASE_BOOT    1
  18
  19 /**
  20  * struct stm32_copro_privdata - power processor private data
  21  * @reset_ctl:          reset controller handle
  22  * @hold_boot_regmap:   regmap for remote processor reset hold boot
  23  * @hold_boot_offset:   offset of the register controlling the hold boot setting
  24  * @hold_boot_mask:     bitmask of the register for the hold boot field
  25  * @is_running:         is the remote processor running
  26  */
  27 struct stm32_copro_privdata {
  28         struct reset_ctl reset_ctl;
  29         struct regmap *hold_boot_regmap;
  30         uint hold_boot_offset;
  31         uint hold_boot_mask;
  32         bool is_running;
  33 };
  34
  35 /**
  36  * stm32_copro_probe() - Basic probe
  37  * @dev:        corresponding STM32 remote processor device
  38  * @return 0 if all went ok, else corresponding -ve error
  39  */
  40 static int stm32_copro_probe(struct udevice *dev)
  41 {
  42         struct stm32_copro_privdata *priv;
  43         struct regmap *regmap;
  44         const fdt32_t *cell;
  45         int len, ret;
  46
  47         priv = dev_get_priv(dev);
  48
  49         regmap = syscon_regmap_lookup_by_phandle(dev, "st,syscfg-holdboot");
  50         if (IS_ERR(regmap)) {
  51                 dev_err(dev, "unable to find holdboot regmap (%ld)\n",
  52                         PTR_ERR(regmap));
  53                 return PTR_ERR(regmap);
  54         }
  55
  56         cell = dev_read_prop(dev, "st,syscfg-holdboot", &len);
  57         if (len < 3 * sizeof(fdt32_t)) {
  58                 dev_err(dev, "holdboot offset and mask not available\n");
  59                 return -EINVAL;
  60         }
  61
  62         priv->hold_boot_regmap = regmap;
  63         priv->hold_boot_offset = fdtdec_get_number(cell + 1, 1);
  64         priv->hold_boot_mask = fdtdec_get_number(cell + 2, 1);
  65
  66         ret = reset_get_by_index(dev, 0, &priv->reset_ctl);
  67         if (ret) {
  68                 dev_err(dev, "failed to get reset (%d)\n", ret);
  69                 return ret;
  70         }
  71
  72         dev_dbg(dev, "probed\n");
  73
  74         return 0;
  75 }
  76
  77 /**
  78  * stm32_copro_set_hold_boot() - Hold boot bit management
  79  * @dev:        corresponding STM32 remote processor device
  80  * @hold:       hold boot value
  81  * @return 0 if all went ok, else corresponding -ve error
  82  */
  83 static int stm32_copro_set_hold_boot(struct udevice *dev, bool hold)
  84 {
  85         struct stm32_copro_privdata *priv;
  86         uint val;
  87         int ret;
  88
  89         priv = dev_get_priv(dev);
  90
  91         val = hold ? RCC_GCR_HOLD_BOOT : RCC_GCR_RELEASE_BOOT;
  92
  93         /*
  94          * Note: shall run an SMC call (STM32_SMC_RCC) if platform is secured.
  95          * To be updated when the code for this SMC service is available which
  96          * is not the case for the time being.
  97          */
  98         ret = regmap_update_bits(priv->hold_boot_regmap, priv->hold_boot_offset,
  99                                  priv->hold_boot_mask, val);
 100         if (ret)
 101                 dev_err(dev, "failed to set hold boot\n");
 102
 103         return ret;
 104 }
 105
 106 /**
 107  * stm32_copro_device_to_virt() - Convert device address to virtual address
 108  * @dev:        corresponding STM32 remote processor device
 109  * @da:         device address
 110  * @size:       Size of the memory region @da is pointing to
 111  * @return converted virtual address
 112  */
 113 static void *stm32_copro_device_to_virt(struct udevice *dev, ulong da,
 114                                         ulong size)
 115 {
 116         fdt32_t in_addr = cpu_to_be32(da), end_addr;
 117         u64 paddr;
 118
 119         paddr = dev_translate_dma_address(dev, &in_addr);
 120         if (paddr == OF_BAD_ADDR) {
 121                 dev_err(dev, "Unable to convert address %ld\n", da);
 122                 return NULL;
 123         }
 124
 125         end_addr = cpu_to_be32(da + size - 1);
 126         if (dev_translate_dma_address(dev, &end_addr) == OF_BAD_ADDR) {
 127                 dev_err(dev, "Unable to convert address %ld\n", da + size - 1);
 128                 return NULL;
 129         }
 130
 131         return phys_to_virt(paddr);
 132 }
 133
 134 /**
 135  * stm32_copro_load() - Loadup the STM32 remote processor
 136  * @dev:        corresponding STM32 remote processor device
 137  * @addr:       Address in memory where image is stored
 138  * @size:       Size in bytes of the image
 139  * @return 0 if all went ok, else corresponding -ve error
 140  */
 141 static int stm32_copro_load(struct udevice *dev, ulong addr, ulong size)
 142 {
 143         struct stm32_copro_privdata *priv;
 144         int ret;
 145
 146         priv = dev_get_priv(dev);
 147
 148         ret = stm32_copro_set_hold_boot(dev, true);
 149         if (ret)
 150                 return ret;
 151
 152         ret = reset_assert(&priv->reset_ctl);
 153         if (ret) {
 154                 dev_err(dev, "Unable to assert reset line (ret=%d)\n", ret);
 155                 return ret;
 156         }
 157
 158         /* Support only ELF32 image */
 159         ret = rproc_elf32_sanity_check(addr, size);
 160         if (ret) {
 161                 dev_err(dev, "Invalid ELF32 image (%d)\n", ret);
 162                 return ret;
 163         }
 164
 165         return rproc_elf32_load_image(dev, addr);
 166 }
 167
 168 /**
 169  * stm32_copro_start() - Start the STM32 remote processor
 170  * @dev:        corresponding STM32 remote processor device
 171  * @return 0 if all went ok, else corresponding -ve error
 172  */
 173 static int stm32_copro_start(struct udevice *dev)
 174 {
 175         struct stm32_copro_privdata *priv;
 176         int ret;
 177
 178         priv = dev_get_priv(dev);
 179
 180         /* move hold boot from true to false start the copro */
 181         ret = stm32_copro_set_hold_boot(dev, false);
 182         if (ret)
 183                 return ret;
 184
 185         /*
 186          * Once copro running, reset hold boot flag to avoid copro
 187          * rebooting autonomously
 188          */
 189         ret = stm32_copro_set_hold_boot(dev, true);
 190         priv->is_running = !ret;
 191         return ret;
 192 }
 193
 194 /**
 195  * stm32_copro_reset() - Reset the STM32 remote processor
 196  * @dev:        corresponding STM32 remote processor device
 197  * @return 0 if all went ok, else corresponding -ve error
 198  */
 199 static int stm32_copro_reset(struct udevice *dev)
 200 {
 201         struct stm32_copro_privdata *priv;
 202         int ret;
 203
 204         priv = dev_get_priv(dev);
 205
 206         ret = stm32_copro_set_hold_boot(dev, true);
 207         if (ret)
 208                 return ret;
 209
 210         ret = reset_assert(&priv->reset_ctl);
 211         if (ret) {
 212                 dev_err(dev, "Unable to assert reset line (ret=%d)\n", ret);
 213                 return ret;
 214         }
 215
 216         priv->is_running = false;
 217
 218         return 0;
 219 }
 220
 221 /**
 222  * stm32_copro_stop() - Stop the STM32 remote processor
 223  * @dev:        corresponding STM32 remote processor device
 224  * @return 0 if all went ok, else corresponding -ve error
 225  */
 226 static int stm32_copro_stop(struct udevice *dev)
 227 {
 228         return stm32_copro_reset(dev);
 229 }
 230
 231 /**
 232  * stm32_copro_is_running() - Is the STM32 remote processor running
 233  * @dev:        corresponding STM32 remote processor device
 234  * @return 1 if the remote processor is running, 0 otherwise
 235  */
 236 static int stm32_copro_is_running(struct udevice *dev)
 237 {
 238         struct stm32_copro_privdata *priv;
 239
 240         priv = dev_get_priv(dev);
 241         return priv->is_running;
 242 }
 243
 244 static const struct dm_rproc_ops stm32_copro_ops = {
 245         .load = stm32_copro_load,
 246         .start = stm32_copro_start,
 247         .stop =  stm32_copro_stop,
 248         .reset = stm32_copro_reset,
 249         .is_running = stm32_copro_is_running,
 250         .device_to_virt = stm32_copro_device_to_virt,
 251 };
 252
 253 static const struct udevice_id stm32_copro_ids[] = {
 254         {.compatible = "st,stm32mp1-m4"},
 255         {}
 256 };
 257
 258 U_BOOT_DRIVER(stm32_copro) = {
 259         .name = "stm32_m4_proc",
 260         .of_match = stm32_copro_ids,
 261         .id = UCLASS_REMOTEPROC,
 262         .ops = &stm32_copro_ops,
 263         .probe = stm32_copro_probe,
 264         .priv_auto_alloc_size = sizeof(struct stm32_copro_privdata),
 265 };