remoteproc_core.c 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635
  1. /*
  2. * Remote Processor Framework
  3. *
  4. * Copyright (C) 2011 Texas Instruments, Inc.
  5. * Copyright (C) 2011 Google, Inc.
  6. *
  7. * Ohad Ben-Cohen <ohad@wizery.com>
  8. * Brian Swetland <swetland@google.com>
  9. * Mark Grosen <mgrosen@ti.com>
  10. * Fernando Guzman Lugo <fernando.lugo@ti.com>
  11. * Suman Anna <s-anna@ti.com>
  12. * Robert Tivy <rtivy@ti.com>
  13. * Armando Uribe De Leon <x0095078@ti.com>
  14. *
  15. * This program is free software; you can redistribute it and/or
  16. * modify it under the terms of the GNU General Public License
  17. * version 2 as published by the Free Software Foundation.
  18. *
  19. * This program is distributed in the hope that it will be useful,
  20. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  22. * GNU General Public License for more details.
  23. */
  24. #define pr_fmt(fmt) "%s: " fmt, __func__
  25. #include <linux/kernel.h>
  26. #include <linux/module.h>
  27. #include <linux/device.h>
  28. #include <linux/slab.h>
  29. #include <linux/mutex.h>
  30. #include <linux/dma-mapping.h>
  31. #include <linux/firmware.h>
  32. #include <linux/string.h>
  33. #include <linux/debugfs.h>
  34. #include <linux/remoteproc.h>
  35. #include <linux/iommu.h>
  36. #include <linux/idr.h>
  37. #include <linux/elf.h>
  38. #include <linux/crc32.h>
  39. #include <linux/virtio_ids.h>
  40. #include <linux/virtio_ring.h>
  41. #include <asm/byteorder.h>
  42. #include "remoteproc_internal.h"
  43. static DEFINE_MUTEX(rproc_list_mutex);
  44. static LIST_HEAD(rproc_list);
  45. typedef int (*rproc_handle_resources_t)(struct rproc *rproc,
  46. struct resource_table *table, int len);
  47. typedef int (*rproc_handle_resource_t)(struct rproc *rproc,
  48. void *, int offset, int avail);
  49. /* Unique indices for remoteproc devices */
  50. static DEFINE_IDA(rproc_dev_index);
  51. static const char * const rproc_crash_names[] = {
  52. [RPROC_MMUFAULT] = "mmufault",
  53. [RPROC_WATCHDOG] = "watchdog",
  54. [RPROC_FATAL_ERROR] = "fatal error",
  55. };
  56. /* translate rproc_crash_type to string */
  57. static const char *rproc_crash_to_string(enum rproc_crash_type type)
  58. {
  59. if (type < ARRAY_SIZE(rproc_crash_names))
  60. return rproc_crash_names[type];
  61. return "unknown";
  62. }
  63. /*
  64. * This is the IOMMU fault handler we register with the IOMMU API
  65. * (when relevant; not all remote processors access memory through
  66. * an IOMMU).
  67. *
  68. * IOMMU core will invoke this handler whenever the remote processor
  69. * will try to access an unmapped device address.
  70. */
  71. static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
  72. unsigned long iova, int flags, void *token)
  73. {
  74. struct rproc *rproc = token;
  75. dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
  76. rproc_report_crash(rproc, RPROC_MMUFAULT);
  77. /*
  78. * Let the iommu core know we're not really handling this fault;
  79. * we just used it as a recovery trigger.
  80. */
  81. return -ENOSYS;
  82. }
  83. static int rproc_enable_iommu(struct rproc *rproc)
  84. {
  85. struct iommu_domain *domain;
  86. struct device *dev = rproc->dev.parent;
  87. int ret;
  88. if (!rproc->has_iommu) {
  89. dev_dbg(dev, "iommu not present\n");
  90. return 0;
  91. }
  92. domain = iommu_domain_alloc(dev->bus);
  93. if (!domain) {
  94. dev_err(dev, "can't alloc iommu domain\n");
  95. return -ENOMEM;
  96. }
  97. iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
  98. ret = iommu_attach_device(domain, dev);
  99. if (ret) {
  100. dev_err(dev, "can't attach iommu device: %d\n", ret);
  101. goto free_domain;
  102. }
  103. rproc->domain = domain;
  104. return 0;
  105. free_domain:
  106. iommu_domain_free(domain);
  107. return ret;
  108. }
  109. static void rproc_disable_iommu(struct rproc *rproc)
  110. {
  111. struct iommu_domain *domain = rproc->domain;
  112. struct device *dev = rproc->dev.parent;
  113. if (!domain)
  114. return;
  115. iommu_detach_device(domain, dev);
  116. iommu_domain_free(domain);
  117. }
  118. /**
  119. * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address
  120. * @rproc: handle of a remote processor
  121. * @da: remoteproc device address to translate
  122. * @len: length of the memory region @da is pointing to
  123. *
  124. * Some remote processors will ask us to allocate them physically contiguous
  125. * memory regions (which we call "carveouts"), and map them to specific
  126. * device addresses (which are hardcoded in the firmware). They may also have
  127. * dedicated memory regions internal to the processors, and use them either
  128. * exclusively or alongside carveouts.
  129. *
  130. * They may then ask us to copy objects into specific device addresses (e.g.
  131. * code/data sections) or expose us certain symbols in other device address
  132. * (e.g. their trace buffer).
  133. *
  134. * This function is a helper function with which we can go over the allocated
  135. * carveouts and translate specific device addresses to kernel virtual addresses
  136. * so we can access the referenced memory. This function also allows to perform
  137. * translations on the internal remoteproc memory regions through a platform
  138. * implementation specific da_to_va ops, if present.
  139. *
  140. * The function returns a valid kernel address on success or NULL on failure.
  141. *
  142. * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
  143. * but only on kernel direct mapped RAM memory. Instead, we're just using
  144. * here the output of the DMA API for the carveouts, which should be more
  145. * correct.
  146. */
  147. void *rproc_da_to_va(struct rproc *rproc, u64 da, int len)
  148. {
  149. struct rproc_mem_entry *carveout;
  150. void *ptr = NULL;
  151. if (rproc->ops->da_to_va) {
  152. ptr = rproc->ops->da_to_va(rproc, da, len);
  153. if (ptr)
  154. goto out;
  155. }
  156. list_for_each_entry(carveout, &rproc->carveouts, node) {
  157. int offset = da - carveout->da;
  158. /* try next carveout if da is too small */
  159. if (offset < 0)
  160. continue;
  161. /* try next carveout if da is too large */
  162. if (offset + len > carveout->len)
  163. continue;
  164. ptr = carveout->va + offset;
  165. break;
  166. }
  167. out:
  168. return ptr;
  169. }
  170. EXPORT_SYMBOL(rproc_da_to_va);
  171. int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
  172. {
  173. struct rproc *rproc = rvdev->rproc;
  174. struct device *dev = &rproc->dev;
  175. struct rproc_vring *rvring = &rvdev->vring[i];
  176. struct fw_rsc_vdev *rsc;
  177. dma_addr_t dma;
  178. void *va;
  179. int ret, size, notifyid;
  180. /* actual size of vring (in bytes) */
  181. size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
  182. /*
  183. * Allocate non-cacheable memory for the vring. In the future
  184. * this call will also configure the IOMMU for us
  185. */
  186. va = dma_alloc_coherent(dev->parent, size, &dma, GFP_KERNEL);
  187. if (!va) {
  188. dev_err(dev->parent, "dma_alloc_coherent failed\n");
  189. return -EINVAL;
  190. }
  191. /*
  192. * Assign an rproc-wide unique index for this vring
  193. * TODO: assign a notifyid for rvdev updates as well
  194. * TODO: support predefined notifyids (via resource table)
  195. */
  196. ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL);
  197. if (ret < 0) {
  198. dev_err(dev, "idr_alloc failed: %d\n", ret);
  199. dma_free_coherent(dev->parent, size, va, dma);
  200. return ret;
  201. }
  202. notifyid = ret;
  203. /* Potentially bump max_notifyid */
  204. if (notifyid > rproc->max_notifyid)
  205. rproc->max_notifyid = notifyid;
  206. dev_dbg(dev, "vring%d: va %p dma %pad size 0x%x idr %d\n",
  207. i, va, &dma, size, notifyid);
  208. rvring->va = va;
  209. rvring->dma = dma;
  210. rvring->notifyid = notifyid;
  211. /*
  212. * Let the rproc know the notifyid and da of this vring.
  213. * Not all platforms use dma_alloc_coherent to automatically
  214. * set up the iommu. In this case the device address (da) will
  215. * hold the physical address and not the device address.
  216. */
  217. rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
  218. rsc->vring[i].da = dma;
  219. rsc->vring[i].notifyid = notifyid;
  220. return 0;
  221. }
  222. static int
  223. rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
  224. {
  225. struct rproc *rproc = rvdev->rproc;
  226. struct device *dev = &rproc->dev;
  227. struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
  228. struct rproc_vring *rvring = &rvdev->vring[i];
  229. dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n",
  230. i, vring->da, vring->num, vring->align);
  231. /* verify queue size and vring alignment are sane */
  232. if (!vring->num || !vring->align) {
  233. dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
  234. vring->num, vring->align);
  235. return -EINVAL;
  236. }
  237. rvring->len = vring->num;
  238. rvring->align = vring->align;
  239. rvring->rvdev = rvdev;
  240. return 0;
  241. }
  242. void rproc_free_vring(struct rproc_vring *rvring)
  243. {
  244. int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
  245. struct rproc *rproc = rvring->rvdev->rproc;
  246. int idx = rvring - rvring->rvdev->vring;
  247. struct fw_rsc_vdev *rsc;
  248. dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma);
  249. idr_remove(&rproc->notifyids, rvring->notifyid);
  250. /* reset resource entry info */
  251. rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset;
  252. rsc->vring[idx].da = 0;
  253. rsc->vring[idx].notifyid = -1;
  254. }
  255. static int rproc_vdev_do_probe(struct rproc_subdev *subdev)
  256. {
  257. struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
  258. return rproc_add_virtio_dev(rvdev, rvdev->id);
  259. }
  260. static void rproc_vdev_do_remove(struct rproc_subdev *subdev)
  261. {
  262. struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
  263. rproc_remove_virtio_dev(rvdev);
  264. }
  265. /**
  266. * rproc_handle_vdev() - handle a vdev fw resource
  267. * @rproc: the remote processor
  268. * @rsc: the vring resource descriptor
  269. * @avail: size of available data (for sanity checking the image)
  270. *
  271. * This resource entry requests the host to statically register a virtio
  272. * device (vdev), and setup everything needed to support it. It contains
  273. * everything needed to make it possible: the virtio device id, virtio
  274. * device features, vrings information, virtio config space, etc...
  275. *
  276. * Before registering the vdev, the vrings are allocated from non-cacheable
  277. * physically contiguous memory. Currently we only support two vrings per
  278. * remote processor (temporary limitation). We might also want to consider
  279. * doing the vring allocation only later when ->find_vqs() is invoked, and
  280. * then release them upon ->del_vqs().
  281. *
  282. * Note: @da is currently not really handled correctly: we dynamically
  283. * allocate it using the DMA API, ignoring requested hard coded addresses,
  284. * and we don't take care of any required IOMMU programming. This is all
  285. * going to be taken care of when the generic iommu-based DMA API will be
  286. * merged. Meanwhile, statically-addressed iommu-based firmware images should
  287. * use RSC_DEVMEM resource entries to map their required @da to the physical
  288. * address of their base CMA region (ouch, hacky!).
  289. *
  290. * Returns 0 on success, or an appropriate error code otherwise
  291. */
  292. static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
  293. int offset, int avail)
  294. {
  295. struct device *dev = &rproc->dev;
  296. struct rproc_vdev *rvdev;
  297. int i, ret;
  298. /* make sure resource isn't truncated */
  299. if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring)
  300. + rsc->config_len > avail) {
  301. dev_err(dev, "vdev rsc is truncated\n");
  302. return -EINVAL;
  303. }
  304. /* make sure reserved bytes are zeroes */
  305. if (rsc->reserved[0] || rsc->reserved[1]) {
  306. dev_err(dev, "vdev rsc has non zero reserved bytes\n");
  307. return -EINVAL;
  308. }
  309. dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n",
  310. rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
  311. /* we currently support only two vrings per rvdev */
  312. if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
  313. dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
  314. return -EINVAL;
  315. }
  316. rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL);
  317. if (!rvdev)
  318. return -ENOMEM;
  319. kref_init(&rvdev->refcount);
  320. rvdev->id = rsc->id;
  321. rvdev->rproc = rproc;
  322. /* parse the vrings */
  323. for (i = 0; i < rsc->num_of_vrings; i++) {
  324. ret = rproc_parse_vring(rvdev, rsc, i);
  325. if (ret)
  326. goto free_rvdev;
  327. }
  328. /* remember the resource offset*/
  329. rvdev->rsc_offset = offset;
  330. /* allocate the vring resources */
  331. for (i = 0; i < rsc->num_of_vrings; i++) {
  332. ret = rproc_alloc_vring(rvdev, i);
  333. if (ret)
  334. goto unwind_vring_allocations;
  335. }
  336. list_add_tail(&rvdev->node, &rproc->rvdevs);
  337. rproc_add_subdev(rproc, &rvdev->subdev,
  338. rproc_vdev_do_probe, rproc_vdev_do_remove);
  339. return 0;
  340. unwind_vring_allocations:
  341. for (i--; i >= 0; i--)
  342. rproc_free_vring(&rvdev->vring[i]);
  343. free_rvdev:
  344. kfree(rvdev);
  345. return ret;
  346. }
  347. void rproc_vdev_release(struct kref *ref)
  348. {
  349. struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount);
  350. struct rproc_vring *rvring;
  351. struct rproc *rproc = rvdev->rproc;
  352. int id;
  353. for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) {
  354. rvring = &rvdev->vring[id];
  355. if (!rvring->va)
  356. continue;
  357. rproc_free_vring(rvring);
  358. }
  359. rproc_remove_subdev(rproc, &rvdev->subdev);
  360. list_del(&rvdev->node);
  361. kfree(rvdev);
  362. }
  363. /**
  364. * rproc_handle_trace() - handle a shared trace buffer resource
  365. * @rproc: the remote processor
  366. * @rsc: the trace resource descriptor
  367. * @avail: size of available data (for sanity checking the image)
  368. *
  369. * In case the remote processor dumps trace logs into memory,
  370. * export it via debugfs.
  371. *
  372. * Currently, the 'da' member of @rsc should contain the device address
  373. * where the remote processor is dumping the traces. Later we could also
  374. * support dynamically allocating this address using the generic
  375. * DMA API (but currently there isn't a use case for that).
  376. *
  377. * Returns 0 on success, or an appropriate error code otherwise
  378. */
  379. static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
  380. int offset, int avail)
  381. {
  382. struct rproc_mem_entry *trace;
  383. struct device *dev = &rproc->dev;
  384. void *ptr;
  385. char name[15];
  386. if (sizeof(*rsc) > avail) {
  387. dev_err(dev, "trace rsc is truncated\n");
  388. return -EINVAL;
  389. }
  390. /* make sure reserved bytes are zeroes */
  391. if (rsc->reserved) {
  392. dev_err(dev, "trace rsc has non zero reserved bytes\n");
  393. return -EINVAL;
  394. }
  395. /* what's the kernel address of this resource ? */
  396. ptr = rproc_da_to_va(rproc, rsc->da, rsc->len);
  397. if (!ptr) {
  398. dev_err(dev, "erroneous trace resource entry\n");
  399. return -EINVAL;
  400. }
  401. trace = kzalloc(sizeof(*trace), GFP_KERNEL);
  402. if (!trace)
  403. return -ENOMEM;
  404. /* set the trace buffer dma properties */
  405. trace->len = rsc->len;
  406. trace->va = ptr;
  407. /* make sure snprintf always null terminates, even if truncating */
  408. snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
  409. /* create the debugfs entry */
  410. trace->priv = rproc_create_trace_file(name, rproc, trace);
  411. if (!trace->priv) {
  412. trace->va = NULL;
  413. kfree(trace);
  414. return -EINVAL;
  415. }
  416. list_add_tail(&trace->node, &rproc->traces);
  417. rproc->num_traces++;
  418. dev_dbg(dev, "%s added: va %p, da 0x%x, len 0x%x\n",
  419. name, ptr, rsc->da, rsc->len);
  420. return 0;
  421. }
  422. /**
  423. * rproc_handle_devmem() - handle devmem resource entry
  424. * @rproc: remote processor handle
  425. * @rsc: the devmem resource entry
  426. * @avail: size of available data (for sanity checking the image)
  427. *
  428. * Remote processors commonly need to access certain on-chip peripherals.
  429. *
  430. * Some of these remote processors access memory via an iommu device,
  431. * and might require us to configure their iommu before they can access
  432. * the on-chip peripherals they need.
  433. *
  434. * This resource entry is a request to map such a peripheral device.
  435. *
  436. * These devmem entries will contain the physical address of the device in
  437. * the 'pa' member. If a specific device address is expected, then 'da' will
  438. * contain it (currently this is the only use case supported). 'len' will
  439. * contain the size of the physical region we need to map.
  440. *
  441. * Currently we just "trust" those devmem entries to contain valid physical
  442. * addresses, but this is going to change: we want the implementations to
  443. * tell us ranges of physical addresses the firmware is allowed to request,
  444. * and not allow firmwares to request access to physical addresses that
  445. * are outside those ranges.
  446. */
  447. static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
  448. int offset, int avail)
  449. {
  450. struct rproc_mem_entry *mapping;
  451. struct device *dev = &rproc->dev;
  452. int ret;
  453. /* no point in handling this resource without a valid iommu domain */
  454. if (!rproc->domain)
  455. return -EINVAL;
  456. if (sizeof(*rsc) > avail) {
  457. dev_err(dev, "devmem rsc is truncated\n");
  458. return -EINVAL;
  459. }
  460. /* make sure reserved bytes are zeroes */
  461. if (rsc->reserved) {
  462. dev_err(dev, "devmem rsc has non zero reserved bytes\n");
  463. return -EINVAL;
  464. }
  465. mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
  466. if (!mapping)
  467. return -ENOMEM;
  468. ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
  469. if (ret) {
  470. dev_err(dev, "failed to map devmem: %d\n", ret);
  471. goto out;
  472. }
  473. /*
  474. * We'll need this info later when we'll want to unmap everything
  475. * (e.g. on shutdown).
  476. *
  477. * We can't trust the remote processor not to change the resource
  478. * table, so we must maintain this info independently.
  479. */
  480. mapping->da = rsc->da;
  481. mapping->len = rsc->len;
  482. list_add_tail(&mapping->node, &rproc->mappings);
  483. dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
  484. rsc->pa, rsc->da, rsc->len);
  485. return 0;
  486. out:
  487. kfree(mapping);
  488. return ret;
  489. }
  490. /**
  491. * rproc_handle_carveout() - handle phys contig memory allocation requests
  492. * @rproc: rproc handle
  493. * @rsc: the resource entry
  494. * @avail: size of available data (for image validation)
  495. *
  496. * This function will handle firmware requests for allocation of physically
  497. * contiguous memory regions.
  498. *
  499. * These request entries should come first in the firmware's resource table,
  500. * as other firmware entries might request placing other data objects inside
  501. * these memory regions (e.g. data/code segments, trace resource entries, ...).
  502. *
  503. * Allocating memory this way helps utilizing the reserved physical memory
  504. * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
  505. * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
  506. * pressure is important; it may have a substantial impact on performance.
  507. */
  508. static int rproc_handle_carveout(struct rproc *rproc,
  509. struct fw_rsc_carveout *rsc,
  510. int offset, int avail)
  511. {
  512. struct rproc_mem_entry *carveout, *mapping;
  513. struct device *dev = &rproc->dev;
  514. dma_addr_t dma;
  515. void *va;
  516. int ret;
  517. if (sizeof(*rsc) > avail) {
  518. dev_err(dev, "carveout rsc is truncated\n");
  519. return -EINVAL;
  520. }
  521. /* make sure reserved bytes are zeroes */
  522. if (rsc->reserved) {
  523. dev_err(dev, "carveout rsc has non zero reserved bytes\n");
  524. return -EINVAL;
  525. }
  526. dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n",
  527. rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags);
  528. carveout = kzalloc(sizeof(*carveout), GFP_KERNEL);
  529. if (!carveout)
  530. return -ENOMEM;
  531. va = dma_alloc_coherent(dev->parent, rsc->len, &dma, GFP_KERNEL);
  532. if (!va) {
  533. dev_err(dev->parent,
  534. "failed to allocate dma memory: len 0x%x\n", rsc->len);
  535. ret = -ENOMEM;
  536. goto free_carv;
  537. }
  538. dev_dbg(dev, "carveout va %p, dma %pad, len 0x%x\n",
  539. va, &dma, rsc->len);
  540. /*
  541. * Ok, this is non-standard.
  542. *
  543. * Sometimes we can't rely on the generic iommu-based DMA API
  544. * to dynamically allocate the device address and then set the IOMMU
  545. * tables accordingly, because some remote processors might
  546. * _require_ us to use hard coded device addresses that their
  547. * firmware was compiled with.
  548. *
  549. * In this case, we must use the IOMMU API directly and map
  550. * the memory to the device address as expected by the remote
  551. * processor.
  552. *
  553. * Obviously such remote processor devices should not be configured
  554. * to use the iommu-based DMA API: we expect 'dma' to contain the
  555. * physical address in this case.
  556. */
  557. if (rproc->domain) {
  558. mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
  559. if (!mapping) {
  560. ret = -ENOMEM;
  561. goto dma_free;
  562. }
  563. ret = iommu_map(rproc->domain, rsc->da, dma, rsc->len,
  564. rsc->flags);
  565. if (ret) {
  566. dev_err(dev, "iommu_map failed: %d\n", ret);
  567. goto free_mapping;
  568. }
  569. /*
  570. * We'll need this info later when we'll want to unmap
  571. * everything (e.g. on shutdown).
  572. *
  573. * We can't trust the remote processor not to change the
  574. * resource table, so we must maintain this info independently.
  575. */
  576. mapping->da = rsc->da;
  577. mapping->len = rsc->len;
  578. list_add_tail(&mapping->node, &rproc->mappings);
  579. dev_dbg(dev, "carveout mapped 0x%x to %pad\n",
  580. rsc->da, &dma);
  581. }
  582. /*
  583. * Some remote processors might need to know the pa
  584. * even though they are behind an IOMMU. E.g., OMAP4's
  585. * remote M3 processor needs this so it can control
  586. * on-chip hardware accelerators that are not behind
  587. * the IOMMU, and therefor must know the pa.
  588. *
  589. * Generally we don't want to expose physical addresses
  590. * if we don't have to (remote processors are generally
  591. * _not_ trusted), so we might want to do this only for
  592. * remote processor that _must_ have this (e.g. OMAP4's
  593. * dual M3 subsystem).
  594. *
  595. * Non-IOMMU processors might also want to have this info.
  596. * In this case, the device address and the physical address
  597. * are the same.
  598. */
  599. rsc->pa = dma;
  600. carveout->va = va;
  601. carveout->len = rsc->len;
  602. carveout->dma = dma;
  603. carveout->da = rsc->da;
  604. list_add_tail(&carveout->node, &rproc->carveouts);
  605. return 0;
  606. free_mapping:
  607. kfree(mapping);
  608. dma_free:
  609. dma_free_coherent(dev->parent, rsc->len, va, dma);
  610. free_carv:
  611. kfree(carveout);
  612. return ret;
  613. }
  614. /*
  615. * A lookup table for resource handlers. The indices are defined in
  616. * enum fw_resource_type.
  617. */
  618. static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = {
  619. [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
  620. [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
  621. [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
  622. [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev,
  623. };
  624. /* handle firmware resource entries before booting the remote processor */
  625. static int rproc_handle_resources(struct rproc *rproc, int len,
  626. rproc_handle_resource_t handlers[RSC_LAST])
  627. {
  628. struct device *dev = &rproc->dev;
  629. rproc_handle_resource_t handler;
  630. int ret = 0, i;
  631. for (i = 0; i < rproc->table_ptr->num; i++) {
  632. int offset = rproc->table_ptr->offset[i];
  633. struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset;
  634. int avail = len - offset - sizeof(*hdr);
  635. void *rsc = (void *)hdr + sizeof(*hdr);
  636. /* make sure table isn't truncated */
  637. if (avail < 0) {
  638. dev_err(dev, "rsc table is truncated\n");
  639. return -EINVAL;
  640. }
  641. dev_dbg(dev, "rsc: type %d\n", hdr->type);
  642. if (hdr->type >= RSC_LAST) {
  643. dev_warn(dev, "unsupported resource %d\n", hdr->type);
  644. continue;
  645. }
  646. handler = handlers[hdr->type];
  647. if (!handler)
  648. continue;
  649. ret = handler(rproc, rsc, offset + sizeof(*hdr), avail);
  650. if (ret)
  651. break;
  652. }
  653. return ret;
  654. }
  655. static int rproc_probe_subdevices(struct rproc *rproc)
  656. {
  657. struct rproc_subdev *subdev;
  658. int ret;
  659. list_for_each_entry(subdev, &rproc->subdevs, node) {
  660. ret = subdev->probe(subdev);
  661. if (ret)
  662. goto unroll_registration;
  663. }
  664. return 0;
  665. unroll_registration:
  666. list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node)
  667. subdev->remove(subdev);
  668. return ret;
  669. }
  670. static void rproc_remove_subdevices(struct rproc *rproc)
  671. {
  672. struct rproc_subdev *subdev;
  673. list_for_each_entry_reverse(subdev, &rproc->subdevs, node)
  674. subdev->remove(subdev);
  675. }
  676. /**
  677. * rproc_resource_cleanup() - clean up and free all acquired resources
  678. * @rproc: rproc handle
  679. *
  680. * This function will free all resources acquired for @rproc, and it
  681. * is called whenever @rproc either shuts down or fails to boot.
  682. */
  683. static void rproc_resource_cleanup(struct rproc *rproc)
  684. {
  685. struct rproc_mem_entry *entry, *tmp;
  686. struct rproc_vdev *rvdev, *rvtmp;
  687. struct device *dev = &rproc->dev;
  688. /* clean up debugfs trace entries */
  689. list_for_each_entry_safe(entry, tmp, &rproc->traces, node) {
  690. rproc_remove_trace_file(entry->priv);
  691. rproc->num_traces--;
  692. list_del(&entry->node);
  693. kfree(entry);
  694. }
  695. /* clean up iommu mapping entries */
  696. list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
  697. size_t unmapped;
  698. unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
  699. if (unmapped != entry->len) {
  700. /* nothing much to do besides complaining */
  701. dev_err(dev, "failed to unmap %u/%zu\n", entry->len,
  702. unmapped);
  703. }
  704. list_del(&entry->node);
  705. kfree(entry);
  706. }
  707. /* clean up carveout allocations */
  708. list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
  709. dma_free_coherent(dev->parent, entry->len, entry->va,
  710. entry->dma);
  711. list_del(&entry->node);
  712. kfree(entry);
  713. }
  714. /* clean up remote vdev entries */
  715. list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
  716. kref_put(&rvdev->refcount, rproc_vdev_release);
  717. }
  718. static int rproc_start(struct rproc *rproc, const struct firmware *fw)
  719. {
  720. struct resource_table *table, *loaded_table;
  721. struct device *dev = &rproc->dev;
  722. int ret, tablesz;
  723. /* look for the resource table */
  724. table = rproc_find_rsc_table(rproc, fw, &tablesz);
  725. if (!table) {
  726. dev_err(dev, "Resource table look up failed\n");
  727. return -EINVAL;
  728. }
  729. /* load the ELF segments to memory */
  730. ret = rproc_load_segments(rproc, fw);
  731. if (ret) {
  732. dev_err(dev, "Failed to load program segments: %d\n", ret);
  733. return ret;
  734. }
  735. /*
  736. * The starting device has been given the rproc->cached_table as the
  737. * resource table. The address of the vring along with the other
  738. * allocated resources (carveouts etc) is stored in cached_table.
  739. * In order to pass this information to the remote device we must copy
  740. * this information to device memory. We also update the table_ptr so
  741. * that any subsequent changes will be applied to the loaded version.
  742. */
  743. loaded_table = rproc_find_loaded_rsc_table(rproc, fw);
  744. if (loaded_table) {
  745. memcpy(loaded_table, rproc->cached_table, tablesz);
  746. rproc->table_ptr = loaded_table;
  747. }
  748. /* power up the remote processor */
  749. ret = rproc->ops->start(rproc);
  750. if (ret) {
  751. dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
  752. return ret;
  753. }
  754. /* probe any subdevices for the remote processor */
  755. ret = rproc_probe_subdevices(rproc);
  756. if (ret) {
  757. dev_err(dev, "failed to probe subdevices for %s: %d\n",
  758. rproc->name, ret);
  759. rproc->ops->stop(rproc);
  760. return ret;
  761. }
  762. rproc->state = RPROC_RUNNING;
  763. dev_info(dev, "remote processor %s is now up\n", rproc->name);
  764. return 0;
  765. }
  766. /*
  767. * take a firmware and boot a remote processor with it.
  768. */
  769. static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
  770. {
  771. struct device *dev = &rproc->dev;
  772. const char *name = rproc->firmware;
  773. struct resource_table *table;
  774. int ret, tablesz;
  775. ret = rproc_fw_sanity_check(rproc, fw);
  776. if (ret)
  777. return ret;
  778. dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
  779. /*
  780. * if enabling an IOMMU isn't relevant for this rproc, this is
  781. * just a nop
  782. */
  783. ret = rproc_enable_iommu(rproc);
  784. if (ret) {
  785. dev_err(dev, "can't enable iommu: %d\n", ret);
  786. return ret;
  787. }
  788. rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
  789. ret = -EINVAL;
  790. /* look for the resource table */
  791. table = rproc_find_rsc_table(rproc, fw, &tablesz);
  792. if (!table) {
  793. dev_err(dev, "Failed to find resource table\n");
  794. goto clean_up;
  795. }
  796. /*
  797. * Create a copy of the resource table. When a virtio device starts
  798. * and calls vring_new_virtqueue() the address of the allocated vring
  799. * will be stored in the cached_table. Before the device is started,
  800. * cached_table will be copied into device memory.
  801. */
  802. rproc->cached_table = kmemdup(table, tablesz, GFP_KERNEL);
  803. if (!rproc->cached_table)
  804. goto clean_up;
  805. rproc->table_ptr = rproc->cached_table;
  806. /* reset max_notifyid */
  807. rproc->max_notifyid = -1;
  808. /* handle fw resources which are required to boot rproc */
  809. ret = rproc_handle_resources(rproc, tablesz, rproc_loading_handlers);
  810. if (ret) {
  811. dev_err(dev, "Failed to process resources: %d\n", ret);
  812. goto clean_up_resources;
  813. }
  814. ret = rproc_start(rproc, fw);
  815. if (ret)
  816. goto clean_up_resources;
  817. return 0;
  818. clean_up_resources:
  819. rproc_resource_cleanup(rproc);
  820. clean_up:
  821. kfree(rproc->cached_table);
  822. rproc->cached_table = NULL;
  823. rproc->table_ptr = NULL;
  824. rproc_disable_iommu(rproc);
  825. return ret;
  826. }
  827. /*
  828. * take a firmware and boot it up.
  829. *
  830. * Note: this function is called asynchronously upon registration of the
  831. * remote processor (so we must wait until it completes before we try
  832. * to unregister the device. one other option is just to use kref here,
  833. * that might be cleaner).
  834. */
  835. static void rproc_auto_boot_callback(const struct firmware *fw, void *context)
  836. {
  837. struct rproc *rproc = context;
  838. rproc_boot(rproc);
  839. release_firmware(fw);
  840. }
  841. static int rproc_trigger_auto_boot(struct rproc *rproc)
  842. {
  843. int ret;
  844. /*
  845. * We're initiating an asynchronous firmware loading, so we can
  846. * be built-in kernel code, without hanging the boot process.
  847. */
  848. ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
  849. rproc->firmware, &rproc->dev, GFP_KERNEL,
  850. rproc, rproc_auto_boot_callback);
  851. if (ret < 0)
  852. dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
  853. return ret;
  854. }
  855. static int rproc_stop(struct rproc *rproc)
  856. {
  857. struct device *dev = &rproc->dev;
  858. int ret;
  859. /* remove any subdevices for the remote processor */
  860. rproc_remove_subdevices(rproc);
  861. /* power off the remote processor */
  862. ret = rproc->ops->stop(rproc);
  863. if (ret) {
  864. dev_err(dev, "can't stop rproc: %d\n", ret);
  865. return ret;
  866. }
  867. /* if in crash state, unlock crash handler */
  868. if (rproc->state == RPROC_CRASHED)
  869. complete_all(&rproc->crash_comp);
  870. rproc->state = RPROC_OFFLINE;
  871. dev_info(dev, "stopped remote processor %s\n", rproc->name);
  872. return 0;
  873. }
  874. /**
  875. * rproc_trigger_recovery() - recover a remoteproc
  876. * @rproc: the remote processor
  877. *
  878. * The recovery is done by resetting all the virtio devices, that way all the
  879. * rpmsg drivers will be reseted along with the remote processor making the
  880. * remoteproc functional again.
  881. *
  882. * This function can sleep, so it cannot be called from atomic context.
  883. */
  884. int rproc_trigger_recovery(struct rproc *rproc)
  885. {
  886. const struct firmware *firmware_p;
  887. struct device *dev = &rproc->dev;
  888. int ret;
  889. dev_err(dev, "recovering %s\n", rproc->name);
  890. init_completion(&rproc->crash_comp);
  891. ret = mutex_lock_interruptible(&rproc->lock);
  892. if (ret)
  893. return ret;
  894. ret = rproc_stop(rproc);
  895. if (ret)
  896. goto unlock_mutex;
  897. /* wait until there is no more rproc users */
  898. wait_for_completion(&rproc->crash_comp);
  899. /* load firmware */
  900. ret = request_firmware(&firmware_p, rproc->firmware, dev);
  901. if (ret < 0) {
  902. dev_err(dev, "request_firmware failed: %d\n", ret);
  903. goto unlock_mutex;
  904. }
  905. /* boot the remote processor up again */
  906. ret = rproc_start(rproc, firmware_p);
  907. release_firmware(firmware_p);
  908. unlock_mutex:
  909. mutex_unlock(&rproc->lock);
  910. return ret;
  911. }
  912. /**
  913. * rproc_crash_handler_work() - handle a crash
  914. *
  915. * This function needs to handle everything related to a crash, like cpu
  916. * registers and stack dump, information to help to debug the fatal error, etc.
  917. */
  918. static void rproc_crash_handler_work(struct work_struct *work)
  919. {
  920. struct rproc *rproc = container_of(work, struct rproc, crash_handler);
  921. struct device *dev = &rproc->dev;
  922. dev_dbg(dev, "enter %s\n", __func__);
  923. mutex_lock(&rproc->lock);
  924. if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
  925. /* handle only the first crash detected */
  926. mutex_unlock(&rproc->lock);
  927. return;
  928. }
  929. rproc->state = RPROC_CRASHED;
  930. dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
  931. rproc->name);
  932. mutex_unlock(&rproc->lock);
  933. if (!rproc->recovery_disabled)
  934. rproc_trigger_recovery(rproc);
  935. }
  936. /**
  937. * rproc_boot() - boot a remote processor
  938. * @rproc: handle of a remote processor
  939. *
  940. * Boot a remote processor (i.e. load its firmware, power it on, ...).
  941. *
  942. * If the remote processor is already powered on, this function immediately
  943. * returns (successfully).
  944. *
  945. * Returns 0 on success, and an appropriate error value otherwise.
  946. */
  947. int rproc_boot(struct rproc *rproc)
  948. {
  949. const struct firmware *firmware_p;
  950. struct device *dev;
  951. int ret;
  952. if (!rproc) {
  953. pr_err("invalid rproc handle\n");
  954. return -EINVAL;
  955. }
  956. dev = &rproc->dev;
  957. ret = mutex_lock_interruptible(&rproc->lock);
  958. if (ret) {
  959. dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
  960. return ret;
  961. }
  962. if (rproc->state == RPROC_DELETED) {
  963. ret = -ENODEV;
  964. dev_err(dev, "can't boot deleted rproc %s\n", rproc->name);
  965. goto unlock_mutex;
  966. }
  967. /* skip the boot process if rproc is already powered up */
  968. if (atomic_inc_return(&rproc->power) > 1) {
  969. ret = 0;
  970. goto unlock_mutex;
  971. }
  972. dev_info(dev, "powering up %s\n", rproc->name);
  973. /* load firmware */
  974. ret = request_firmware(&firmware_p, rproc->firmware, dev);
  975. if (ret < 0) {
  976. dev_err(dev, "request_firmware failed: %d\n", ret);
  977. goto downref_rproc;
  978. }
  979. ret = rproc_fw_boot(rproc, firmware_p);
  980. release_firmware(firmware_p);
  981. downref_rproc:
  982. if (ret)
  983. atomic_dec(&rproc->power);
  984. unlock_mutex:
  985. mutex_unlock(&rproc->lock);
  986. return ret;
  987. }
  988. EXPORT_SYMBOL(rproc_boot);
  989. /**
  990. * rproc_shutdown() - power off the remote processor
  991. * @rproc: the remote processor
  992. *
  993. * Power off a remote processor (previously booted with rproc_boot()).
  994. *
  995. * In case @rproc is still being used by an additional user(s), then
  996. * this function will just decrement the power refcount and exit,
  997. * without really powering off the device.
  998. *
  999. * Every call to rproc_boot() must (eventually) be accompanied by a call
  1000. * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
  1001. *
  1002. * Notes:
  1003. * - we're not decrementing the rproc's refcount, only the power refcount.
  1004. * which means that the @rproc handle stays valid even after rproc_shutdown()
  1005. * returns, and users can still use it with a subsequent rproc_boot(), if
  1006. * needed.
  1007. */
  1008. void rproc_shutdown(struct rproc *rproc)
  1009. {
  1010. struct device *dev = &rproc->dev;
  1011. int ret;
  1012. ret = mutex_lock_interruptible(&rproc->lock);
  1013. if (ret) {
  1014. dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
  1015. return;
  1016. }
  1017. /* if the remote proc is still needed, bail out */
  1018. if (!atomic_dec_and_test(&rproc->power))
  1019. goto out;
  1020. ret = rproc_stop(rproc);
  1021. if (ret) {
  1022. atomic_inc(&rproc->power);
  1023. goto out;
  1024. }
  1025. /* clean up all acquired resources */
  1026. rproc_resource_cleanup(rproc);
  1027. rproc_disable_iommu(rproc);
  1028. /* Free the copy of the resource table */
  1029. kfree(rproc->cached_table);
  1030. rproc->cached_table = NULL;
  1031. rproc->table_ptr = NULL;
  1032. out:
  1033. mutex_unlock(&rproc->lock);
  1034. }
  1035. EXPORT_SYMBOL(rproc_shutdown);
  1036. /**
  1037. * rproc_get_by_phandle() - find a remote processor by phandle
  1038. * @phandle: phandle to the rproc
  1039. *
  1040. * Finds an rproc handle using the remote processor's phandle, and then
  1041. * return a handle to the rproc.
  1042. *
  1043. * This function increments the remote processor's refcount, so always
  1044. * use rproc_put() to decrement it back once rproc isn't needed anymore.
  1045. *
  1046. * Returns the rproc handle on success, and NULL on failure.
  1047. */
  1048. #ifdef CONFIG_OF
  1049. struct rproc *rproc_get_by_phandle(phandle phandle)
  1050. {
  1051. struct rproc *rproc = NULL, *r;
  1052. struct device_node *np;
  1053. np = of_find_node_by_phandle(phandle);
  1054. if (!np)
  1055. return NULL;
  1056. mutex_lock(&rproc_list_mutex);
  1057. list_for_each_entry(r, &rproc_list, node) {
  1058. if (r->dev.parent && r->dev.parent->of_node == np) {
  1059. /* prevent underlying implementation from being removed */
  1060. if (!try_module_get(r->dev.parent->driver->owner)) {
  1061. dev_err(&r->dev, "can't get owner\n");
  1062. break;
  1063. }
  1064. rproc = r;
  1065. get_device(&rproc->dev);
  1066. break;
  1067. }
  1068. }
  1069. mutex_unlock(&rproc_list_mutex);
  1070. of_node_put(np);
  1071. return rproc;
  1072. }
  1073. #else
  1074. struct rproc *rproc_get_by_phandle(phandle phandle)
  1075. {
  1076. return NULL;
  1077. }
  1078. #endif
  1079. EXPORT_SYMBOL(rproc_get_by_phandle);
  1080. /**
  1081. * rproc_add() - register a remote processor
  1082. * @rproc: the remote processor handle to register
  1083. *
  1084. * Registers @rproc with the remoteproc framework, after it has been
  1085. * allocated with rproc_alloc().
  1086. *
  1087. * This is called by the platform-specific rproc implementation, whenever
  1088. * a new remote processor device is probed.
  1089. *
  1090. * Returns 0 on success and an appropriate error code otherwise.
  1091. *
  1092. * Note: this function initiates an asynchronous firmware loading
  1093. * context, which will look for virtio devices supported by the rproc's
  1094. * firmware.
  1095. *
  1096. * If found, those virtio devices will be created and added, so as a result
  1097. * of registering this remote processor, additional virtio drivers might be
  1098. * probed.
  1099. */
  1100. int rproc_add(struct rproc *rproc)
  1101. {
  1102. struct device *dev = &rproc->dev;
  1103. int ret;
  1104. ret = device_add(dev);
  1105. if (ret < 0)
  1106. return ret;
  1107. dev_info(dev, "%s is available\n", rproc->name);
  1108. /* create debugfs entries */
  1109. rproc_create_debug_dir(rproc);
  1110. /* if rproc is marked always-on, request it to boot */
  1111. if (rproc->auto_boot) {
  1112. ret = rproc_trigger_auto_boot(rproc);
  1113. if (ret < 0)
  1114. return ret;
  1115. }
  1116. /* expose to rproc_get_by_phandle users */
  1117. mutex_lock(&rproc_list_mutex);
  1118. list_add(&rproc->node, &rproc_list);
  1119. mutex_unlock(&rproc_list_mutex);
  1120. return 0;
  1121. }
  1122. EXPORT_SYMBOL(rproc_add);
  1123. /**
  1124. * rproc_type_release() - release a remote processor instance
  1125. * @dev: the rproc's device
  1126. *
  1127. * This function should _never_ be called directly.
  1128. *
  1129. * It will be called by the driver core when no one holds a valid pointer
  1130. * to @dev anymore.
  1131. */
  1132. static void rproc_type_release(struct device *dev)
  1133. {
  1134. struct rproc *rproc = container_of(dev, struct rproc, dev);
  1135. dev_info(&rproc->dev, "releasing %s\n", rproc->name);
  1136. idr_destroy(&rproc->notifyids);
  1137. if (rproc->index >= 0)
  1138. ida_simple_remove(&rproc_dev_index, rproc->index);
  1139. kfree(rproc->firmware);
  1140. kfree(rproc);
  1141. }
  1142. static const struct device_type rproc_type = {
  1143. .name = "remoteproc",
  1144. .release = rproc_type_release,
  1145. };
  1146. /**
  1147. * rproc_alloc() - allocate a remote processor handle
  1148. * @dev: the underlying device
  1149. * @name: name of this remote processor
  1150. * @ops: platform-specific handlers (mainly start/stop)
  1151. * @firmware: name of firmware file to load, can be NULL
  1152. * @len: length of private data needed by the rproc driver (in bytes)
  1153. *
  1154. * Allocates a new remote processor handle, but does not register
  1155. * it yet. if @firmware is NULL, a default name is used.
  1156. *
  1157. * This function should be used by rproc implementations during initialization
  1158. * of the remote processor.
  1159. *
  1160. * After creating an rproc handle using this function, and when ready,
  1161. * implementations should then call rproc_add() to complete
  1162. * the registration of the remote processor.
  1163. *
  1164. * On success the new rproc is returned, and on failure, NULL.
  1165. *
  1166. * Note: _never_ directly deallocate @rproc, even if it was not registered
  1167. * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
  1168. */
  1169. struct rproc *rproc_alloc(struct device *dev, const char *name,
  1170. const struct rproc_ops *ops,
  1171. const char *firmware, int len)
  1172. {
  1173. struct rproc *rproc;
  1174. char *p, *template = "rproc-%s-fw";
  1175. int name_len;
  1176. if (!dev || !name || !ops)
  1177. return NULL;
  1178. if (!firmware) {
  1179. /*
  1180. * If the caller didn't pass in a firmware name then
  1181. * construct a default name.
  1182. */
  1183. name_len = strlen(name) + strlen(template) - 2 + 1;
  1184. p = kmalloc(name_len, GFP_KERNEL);
  1185. if (!p)
  1186. return NULL;
  1187. snprintf(p, name_len, template, name);
  1188. } else {
  1189. p = kstrdup(firmware, GFP_KERNEL);
  1190. if (!p)
  1191. return NULL;
  1192. }
  1193. rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL);
  1194. if (!rproc) {
  1195. kfree(p);
  1196. return NULL;
  1197. }
  1198. rproc->firmware = p;
  1199. rproc->name = name;
  1200. rproc->ops = ops;
  1201. rproc->priv = &rproc[1];
  1202. rproc->auto_boot = true;
  1203. device_initialize(&rproc->dev);
  1204. rproc->dev.parent = dev;
  1205. rproc->dev.type = &rproc_type;
  1206. rproc->dev.class = &rproc_class;
  1207. rproc->dev.driver_data = rproc;
  1208. idr_init(&rproc->notifyids);
  1209. /* Assign a unique device index and name */
  1210. rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
  1211. if (rproc->index < 0) {
  1212. dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
  1213. put_device(&rproc->dev);
  1214. return NULL;
  1215. }
  1216. dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
  1217. atomic_set(&rproc->power, 0);
  1218. /* Set ELF as the default fw_ops handler */
  1219. rproc->fw_ops = &rproc_elf_fw_ops;
  1220. mutex_init(&rproc->lock);
  1221. INIT_LIST_HEAD(&rproc->carveouts);
  1222. INIT_LIST_HEAD(&rproc->mappings);
  1223. INIT_LIST_HEAD(&rproc->traces);
  1224. INIT_LIST_HEAD(&rproc->rvdevs);
  1225. INIT_LIST_HEAD(&rproc->subdevs);
  1226. INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
  1227. init_completion(&rproc->crash_comp);
  1228. rproc->state = RPROC_OFFLINE;
  1229. return rproc;
  1230. }
  1231. EXPORT_SYMBOL(rproc_alloc);
  1232. /**
  1233. * rproc_free() - unroll rproc_alloc()
  1234. * @rproc: the remote processor handle
  1235. *
  1236. * This function decrements the rproc dev refcount.
  1237. *
  1238. * If no one holds any reference to rproc anymore, then its refcount would
  1239. * now drop to zero, and it would be freed.
  1240. */
  1241. void rproc_free(struct rproc *rproc)
  1242. {
  1243. put_device(&rproc->dev);
  1244. }
  1245. EXPORT_SYMBOL(rproc_free);
  1246. /**
  1247. * rproc_put() - release rproc reference
  1248. * @rproc: the remote processor handle
  1249. *
  1250. * This function decrements the rproc dev refcount.
  1251. *
  1252. * If no one holds any reference to rproc anymore, then its refcount would
  1253. * now drop to zero, and it would be freed.
  1254. */
  1255. void rproc_put(struct rproc *rproc)
  1256. {
  1257. module_put(rproc->dev.parent->driver->owner);
  1258. put_device(&rproc->dev);
  1259. }
  1260. EXPORT_SYMBOL(rproc_put);
  1261. /**
  1262. * rproc_del() - unregister a remote processor
  1263. * @rproc: rproc handle to unregister
  1264. *
  1265. * This function should be called when the platform specific rproc
  1266. * implementation decides to remove the rproc device. it should
  1267. * _only_ be called if a previous invocation of rproc_add()
  1268. * has completed successfully.
  1269. *
  1270. * After rproc_del() returns, @rproc isn't freed yet, because
  1271. * of the outstanding reference created by rproc_alloc. To decrement that
  1272. * one last refcount, one still needs to call rproc_free().
  1273. *
  1274. * Returns 0 on success and -EINVAL if @rproc isn't valid.
  1275. */
  1276. int rproc_del(struct rproc *rproc)
  1277. {
  1278. if (!rproc)
  1279. return -EINVAL;
  1280. /* if rproc is marked always-on, rproc_add() booted it */
  1281. /* TODO: make sure this works with rproc->power > 1 */
  1282. if (rproc->auto_boot)
  1283. rproc_shutdown(rproc);
  1284. mutex_lock(&rproc->lock);
  1285. rproc->state = RPROC_DELETED;
  1286. mutex_unlock(&rproc->lock);
  1287. rproc_delete_debug_dir(rproc);
  1288. /* the rproc is downref'ed as soon as it's removed from the klist */
  1289. mutex_lock(&rproc_list_mutex);
  1290. list_del(&rproc->node);
  1291. mutex_unlock(&rproc_list_mutex);
  1292. device_del(&rproc->dev);
  1293. return 0;
  1294. }
  1295. EXPORT_SYMBOL(rproc_del);
  1296. /**
  1297. * rproc_add_subdev() - add a subdevice to a remoteproc
  1298. * @rproc: rproc handle to add the subdevice to
  1299. * @subdev: subdev handle to register
  1300. * @probe: function to call when the rproc boots
  1301. * @remove: function to call when the rproc shuts down
  1302. */
  1303. void rproc_add_subdev(struct rproc *rproc,
  1304. struct rproc_subdev *subdev,
  1305. int (*probe)(struct rproc_subdev *subdev),
  1306. void (*remove)(struct rproc_subdev *subdev))
  1307. {
  1308. subdev->probe = probe;
  1309. subdev->remove = remove;
  1310. list_add_tail(&subdev->node, &rproc->subdevs);
  1311. }
  1312. EXPORT_SYMBOL(rproc_add_subdev);
  1313. /**
  1314. * rproc_remove_subdev() - remove a subdevice from a remoteproc
  1315. * @rproc: rproc handle to remove the subdevice from
  1316. * @subdev: subdev handle, previously registered with rproc_add_subdev()
  1317. */
  1318. void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
  1319. {
  1320. list_del(&subdev->node);
  1321. }
  1322. EXPORT_SYMBOL(rproc_remove_subdev);
  1323. /**
  1324. * rproc_get_by_child() - acquire rproc handle of @dev's ancestor
  1325. * @dev: child device to find ancestor of
  1326. *
  1327. * Returns the ancestor rproc instance, or NULL if not found.
  1328. */
  1329. struct rproc *rproc_get_by_child(struct device *dev)
  1330. {
  1331. for (dev = dev->parent; dev; dev = dev->parent) {
  1332. if (dev->type == &rproc_type)
  1333. return dev->driver_data;
  1334. }
  1335. return NULL;
  1336. }
  1337. EXPORT_SYMBOL(rproc_get_by_child);
  1338. /**
  1339. * rproc_report_crash() - rproc crash reporter function
  1340. * @rproc: remote processor
  1341. * @type: crash type
  1342. *
  1343. * This function must be called every time a crash is detected by the low-level
  1344. * drivers implementing a specific remoteproc. This should not be called from a
  1345. * non-remoteproc driver.
  1346. *
  1347. * This function can be called from atomic/interrupt context.
  1348. */
  1349. void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
  1350. {
  1351. if (!rproc) {
  1352. pr_err("NULL rproc pointer\n");
  1353. return;
  1354. }
  1355. dev_err(&rproc->dev, "crash detected in %s: type %s\n",
  1356. rproc->name, rproc_crash_to_string(type));
  1357. /* create a new task to handle the error */
  1358. schedule_work(&rproc->crash_handler);
  1359. }
  1360. EXPORT_SYMBOL(rproc_report_crash);
  1361. static int __init remoteproc_init(void)
  1362. {
  1363. rproc_init_sysfs();
  1364. rproc_init_debugfs();
  1365. return 0;
  1366. }
  1367. subsys_initcall(remoteproc_init);
  1368. static void __exit remoteproc_exit(void)
  1369. {
  1370. ida_destroy(&rproc_dev_index);
  1371. rproc_exit_debugfs();
  1372. rproc_exit_sysfs();
  1373. }
  1374. module_exit(remoteproc_exit);
  1375. MODULE_LICENSE("GPL v2");
  1376. MODULE_DESCRIPTION("Generic Remote Processor Framework");