fsl-mc-bus.c 28 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Freescale Management Complex (MC) bus driver
  4. *
  5. * Copyright (C) 2014-2016 Freescale Semiconductor, Inc.
  6. * Copyright 2019-2020 NXP
  7. * Author: German Rivera <German.Rivera@freescale.com>
  8. *
  9. */
  10. #define pr_fmt(fmt) "fsl-mc: " fmt
  11. #include <linux/module.h>
  12. #include <linux/of_device.h>
  13. #include <linux/of_address.h>
  14. #include <linux/ioport.h>
  15. #include <linux/slab.h>
  16. #include <linux/limits.h>
  17. #include <linux/bitops.h>
  18. #include <linux/msi.h>
  19. #include <linux/dma-mapping.h>
  20. #include <linux/acpi.h>
  21. #include <linux/iommu.h>
  22. #include "fsl-mc-private.h"
  23. /**
  24. * Default DMA mask for devices on a fsl-mc bus
  25. */
  26. #define FSL_MC_DEFAULT_DMA_MASK (~0ULL)
  27. static struct fsl_mc_version mc_version;
  28. /**
  29. * struct fsl_mc - Private data of a "fsl,qoriq-mc" platform device
  30. * @root_mc_bus_dev: fsl-mc device representing the root DPRC
  31. * @num_translation_ranges: number of entries in addr_translation_ranges
  32. * @translation_ranges: array of bus to system address translation ranges
  33. */
  34. struct fsl_mc {
  35. struct fsl_mc_device *root_mc_bus_dev;
  36. u8 num_translation_ranges;
  37. struct fsl_mc_addr_translation_range *translation_ranges;
  38. void *fsl_mc_regs;
  39. };
  40. /**
  41. * struct fsl_mc_addr_translation_range - bus to system address translation
  42. * range
  43. * @mc_region_type: Type of MC region for the range being translated
  44. * @start_mc_offset: Start MC offset of the range being translated
  45. * @end_mc_offset: MC offset of the first byte after the range (last MC
  46. * offset of the range is end_mc_offset - 1)
  47. * @start_phys_addr: system physical address corresponding to start_mc_addr
  48. */
  49. struct fsl_mc_addr_translation_range {
  50. enum dprc_region_type mc_region_type;
  51. u64 start_mc_offset;
  52. u64 end_mc_offset;
  53. phys_addr_t start_phys_addr;
  54. };
  55. #define FSL_MC_FAPR 0x28
  56. #define MC_FAPR_PL BIT(18)
  57. #define MC_FAPR_BMT BIT(17)
  58. static phys_addr_t mc_portal_base_phys_addr;
  59. /**
  60. * fsl_mc_bus_match - device to driver matching callback
  61. * @dev: the fsl-mc device to match against
  62. * @drv: the device driver to search for matching fsl-mc object type
  63. * structures
  64. *
  65. * Returns 1 on success, 0 otherwise.
  66. */
  67. static int fsl_mc_bus_match(struct device *dev, struct device_driver *drv)
  68. {
  69. const struct fsl_mc_device_id *id;
  70. struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
  71. struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(drv);
  72. bool found = false;
  73. /* When driver_override is set, only bind to the matching driver */
  74. if (mc_dev->driver_override) {
  75. found = !strcmp(mc_dev->driver_override, mc_drv->driver.name);
  76. goto out;
  77. }
  78. if (!mc_drv->match_id_table)
  79. goto out;
  80. /*
  81. * If the object is not 'plugged' don't match.
  82. * Only exception is the root DPRC, which is a special case.
  83. */
  84. if ((mc_dev->obj_desc.state & FSL_MC_OBJ_STATE_PLUGGED) == 0 &&
  85. !fsl_mc_is_root_dprc(&mc_dev->dev))
  86. goto out;
  87. /*
  88. * Traverse the match_id table of the given driver, trying to find
  89. * a matching for the given device.
  90. */
  91. for (id = mc_drv->match_id_table; id->vendor != 0x0; id++) {
  92. if (id->vendor == mc_dev->obj_desc.vendor &&
  93. strcmp(id->obj_type, mc_dev->obj_desc.type) == 0) {
  94. found = true;
  95. break;
  96. }
  97. }
  98. out:
  99. dev_dbg(dev, "%smatched\n", found ? "" : "not ");
  100. return found;
  101. }
  102. /**
  103. * fsl_mc_bus_uevent - callback invoked when a device is added
  104. */
  105. static int fsl_mc_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
  106. {
  107. struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
  108. if (add_uevent_var(env, "MODALIAS=fsl-mc:v%08Xd%s",
  109. mc_dev->obj_desc.vendor,
  110. mc_dev->obj_desc.type))
  111. return -ENOMEM;
  112. return 0;
  113. }
  114. static int fsl_mc_dma_configure(struct device *dev)
  115. {
  116. struct device *dma_dev = dev;
  117. struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
  118. u32 input_id = mc_dev->icid;
  119. while (dev_is_fsl_mc(dma_dev))
  120. dma_dev = dma_dev->parent;
  121. if (dev_of_node(dma_dev))
  122. return of_dma_configure_id(dev, dma_dev->of_node, 0, &input_id);
  123. return acpi_dma_configure_id(dev, DEV_DMA_COHERENT, &input_id);
  124. }
  125. static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
  126. char *buf)
  127. {
  128. struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
  129. return sprintf(buf, "fsl-mc:v%08Xd%s\n", mc_dev->obj_desc.vendor,
  130. mc_dev->obj_desc.type);
  131. }
  132. static DEVICE_ATTR_RO(modalias);
  133. static ssize_t driver_override_store(struct device *dev,
  134. struct device_attribute *attr,
  135. const char *buf, size_t count)
  136. {
  137. struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
  138. char *driver_override, *old = mc_dev->driver_override;
  139. char *cp;
  140. if (WARN_ON(dev->bus != &fsl_mc_bus_type))
  141. return -EINVAL;
  142. if (count >= (PAGE_SIZE - 1))
  143. return -EINVAL;
  144. driver_override = kstrndup(buf, count, GFP_KERNEL);
  145. if (!driver_override)
  146. return -ENOMEM;
  147. cp = strchr(driver_override, '\n');
  148. if (cp)
  149. *cp = '\0';
  150. if (strlen(driver_override)) {
  151. mc_dev->driver_override = driver_override;
  152. } else {
  153. kfree(driver_override);
  154. mc_dev->driver_override = NULL;
  155. }
  156. kfree(old);
  157. return count;
  158. }
  159. static ssize_t driver_override_show(struct device *dev,
  160. struct device_attribute *attr, char *buf)
  161. {
  162. struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
  163. return snprintf(buf, PAGE_SIZE, "%s\n", mc_dev->driver_override);
  164. }
  165. static DEVICE_ATTR_RW(driver_override);
  166. static struct attribute *fsl_mc_dev_attrs[] = {
  167. &dev_attr_modalias.attr,
  168. &dev_attr_driver_override.attr,
  169. NULL,
  170. };
  171. ATTRIBUTE_GROUPS(fsl_mc_dev);
  172. struct bus_type fsl_mc_bus_type = {
  173. .name = "fsl-mc",
  174. .match = fsl_mc_bus_match,
  175. .uevent = fsl_mc_bus_uevent,
  176. .dma_configure = fsl_mc_dma_configure,
  177. .dev_groups = fsl_mc_dev_groups,
  178. };
  179. EXPORT_SYMBOL_GPL(fsl_mc_bus_type);
  180. struct device_type fsl_mc_bus_dprc_type = {
  181. .name = "fsl_mc_bus_dprc"
  182. };
  183. EXPORT_SYMBOL_GPL(fsl_mc_bus_dprc_type);
  184. struct device_type fsl_mc_bus_dpni_type = {
  185. .name = "fsl_mc_bus_dpni"
  186. };
  187. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpni_type);
  188. struct device_type fsl_mc_bus_dpio_type = {
  189. .name = "fsl_mc_bus_dpio"
  190. };
  191. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpio_type);
  192. struct device_type fsl_mc_bus_dpsw_type = {
  193. .name = "fsl_mc_bus_dpsw"
  194. };
  195. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpsw_type);
  196. struct device_type fsl_mc_bus_dpbp_type = {
  197. .name = "fsl_mc_bus_dpbp"
  198. };
  199. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpbp_type);
  200. struct device_type fsl_mc_bus_dpcon_type = {
  201. .name = "fsl_mc_bus_dpcon"
  202. };
  203. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpcon_type);
  204. struct device_type fsl_mc_bus_dpmcp_type = {
  205. .name = "fsl_mc_bus_dpmcp"
  206. };
  207. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpmcp_type);
  208. struct device_type fsl_mc_bus_dpmac_type = {
  209. .name = "fsl_mc_bus_dpmac"
  210. };
  211. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpmac_type);
  212. struct device_type fsl_mc_bus_dprtc_type = {
  213. .name = "fsl_mc_bus_dprtc"
  214. };
  215. EXPORT_SYMBOL_GPL(fsl_mc_bus_dprtc_type);
  216. struct device_type fsl_mc_bus_dpseci_type = {
  217. .name = "fsl_mc_bus_dpseci"
  218. };
  219. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpseci_type);
  220. struct device_type fsl_mc_bus_dpdmux_type = {
  221. .name = "fsl_mc_bus_dpdmux"
  222. };
  223. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpdmux_type);
  224. struct device_type fsl_mc_bus_dpdcei_type = {
  225. .name = "fsl_mc_bus_dpdcei"
  226. };
  227. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpdcei_type);
  228. struct device_type fsl_mc_bus_dpaiop_type = {
  229. .name = "fsl_mc_bus_dpaiop"
  230. };
  231. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpaiop_type);
  232. struct device_type fsl_mc_bus_dpci_type = {
  233. .name = "fsl_mc_bus_dpci"
  234. };
  235. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpci_type);
  236. struct device_type fsl_mc_bus_dpdmai_type = {
  237. .name = "fsl_mc_bus_dpdmai"
  238. };
  239. EXPORT_SYMBOL_GPL(fsl_mc_bus_dpdmai_type);
  240. static struct device_type *fsl_mc_get_device_type(const char *type)
  241. {
  242. static const struct {
  243. struct device_type *dev_type;
  244. const char *type;
  245. } dev_types[] = {
  246. { &fsl_mc_bus_dprc_type, "dprc" },
  247. { &fsl_mc_bus_dpni_type, "dpni" },
  248. { &fsl_mc_bus_dpio_type, "dpio" },
  249. { &fsl_mc_bus_dpsw_type, "dpsw" },
  250. { &fsl_mc_bus_dpbp_type, "dpbp" },
  251. { &fsl_mc_bus_dpcon_type, "dpcon" },
  252. { &fsl_mc_bus_dpmcp_type, "dpmcp" },
  253. { &fsl_mc_bus_dpmac_type, "dpmac" },
  254. { &fsl_mc_bus_dprtc_type, "dprtc" },
  255. { &fsl_mc_bus_dpseci_type, "dpseci" },
  256. { &fsl_mc_bus_dpdmux_type, "dpdmux" },
  257. { &fsl_mc_bus_dpdcei_type, "dpdcei" },
  258. { &fsl_mc_bus_dpaiop_type, "dpaiop" },
  259. { &fsl_mc_bus_dpci_type, "dpci" },
  260. { &fsl_mc_bus_dpdmai_type, "dpdmai" },
  261. { NULL, NULL }
  262. };
  263. int i;
  264. for (i = 0; dev_types[i].dev_type; i++)
  265. if (!strcmp(dev_types[i].type, type))
  266. return dev_types[i].dev_type;
  267. return NULL;
  268. }
  269. static int fsl_mc_driver_probe(struct device *dev)
  270. {
  271. struct fsl_mc_driver *mc_drv;
  272. struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
  273. int error;
  274. mc_drv = to_fsl_mc_driver(dev->driver);
  275. error = mc_drv->probe(mc_dev);
  276. if (error < 0) {
  277. if (error != -EPROBE_DEFER)
  278. dev_err(dev, "%s failed: %d\n", __func__, error);
  279. return error;
  280. }
  281. return 0;
  282. }
  283. static int fsl_mc_driver_remove(struct device *dev)
  284. {
  285. struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(dev->driver);
  286. struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
  287. int error;
  288. error = mc_drv->remove(mc_dev);
  289. if (error < 0) {
  290. dev_err(dev, "%s failed: %d\n", __func__, error);
  291. return error;
  292. }
  293. return 0;
  294. }
  295. static void fsl_mc_driver_shutdown(struct device *dev)
  296. {
  297. struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(dev->driver);
  298. struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
  299. mc_drv->shutdown(mc_dev);
  300. }
  301. /**
  302. * __fsl_mc_driver_register - registers a child device driver with the
  303. * MC bus
  304. *
  305. * This function is implicitly invoked from the registration function of
  306. * fsl_mc device drivers, which is generated by the
  307. * module_fsl_mc_driver() macro.
  308. */
  309. int __fsl_mc_driver_register(struct fsl_mc_driver *mc_driver,
  310. struct module *owner)
  311. {
  312. int error;
  313. mc_driver->driver.owner = owner;
  314. mc_driver->driver.bus = &fsl_mc_bus_type;
  315. if (mc_driver->probe)
  316. mc_driver->driver.probe = fsl_mc_driver_probe;
  317. if (mc_driver->remove)
  318. mc_driver->driver.remove = fsl_mc_driver_remove;
  319. if (mc_driver->shutdown)
  320. mc_driver->driver.shutdown = fsl_mc_driver_shutdown;
  321. error = driver_register(&mc_driver->driver);
  322. if (error < 0) {
  323. pr_err("driver_register() failed for %s: %d\n",
  324. mc_driver->driver.name, error);
  325. return error;
  326. }
  327. return 0;
  328. }
  329. EXPORT_SYMBOL_GPL(__fsl_mc_driver_register);
  330. /**
  331. * fsl_mc_driver_unregister - unregisters a device driver from the
  332. * MC bus
  333. */
  334. void fsl_mc_driver_unregister(struct fsl_mc_driver *mc_driver)
  335. {
  336. driver_unregister(&mc_driver->driver);
  337. }
  338. EXPORT_SYMBOL_GPL(fsl_mc_driver_unregister);
  339. /**
  340. * mc_get_version() - Retrieves the Management Complex firmware
  341. * version information
  342. * @mc_io: Pointer to opaque I/O object
  343. * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
  344. * @mc_ver_info: Returned version information structure
  345. *
  346. * Return: '0' on Success; Error code otherwise.
  347. */
  348. static int mc_get_version(struct fsl_mc_io *mc_io,
  349. u32 cmd_flags,
  350. struct fsl_mc_version *mc_ver_info)
  351. {
  352. struct fsl_mc_command cmd = { 0 };
  353. struct dpmng_rsp_get_version *rsp_params;
  354. int err;
  355. /* prepare command */
  356. cmd.header = mc_encode_cmd_header(DPMNG_CMDID_GET_VERSION,
  357. cmd_flags,
  358. 0);
  359. /* send command to mc*/
  360. err = mc_send_command(mc_io, &cmd);
  361. if (err)
  362. return err;
  363. /* retrieve response parameters */
  364. rsp_params = (struct dpmng_rsp_get_version *)cmd.params;
  365. mc_ver_info->revision = le32_to_cpu(rsp_params->revision);
  366. mc_ver_info->major = le32_to_cpu(rsp_params->version_major);
  367. mc_ver_info->minor = le32_to_cpu(rsp_params->version_minor);
  368. return 0;
  369. }
  370. /**
  371. * fsl_mc_get_version - function to retrieve the MC f/w version information
  372. *
  373. * Return: mc version when called after fsl-mc-bus probe; NULL otherwise.
  374. */
  375. struct fsl_mc_version *fsl_mc_get_version(void)
  376. {
  377. if (mc_version.major)
  378. return &mc_version;
  379. return NULL;
  380. }
  381. EXPORT_SYMBOL_GPL(fsl_mc_get_version);
  382. /**
  383. * fsl_mc_get_root_dprc - function to traverse to the root dprc
  384. */
  385. void fsl_mc_get_root_dprc(struct device *dev,
  386. struct device **root_dprc_dev)
  387. {
  388. if (!dev) {
  389. *root_dprc_dev = NULL;
  390. } else if (!dev_is_fsl_mc(dev)) {
  391. *root_dprc_dev = NULL;
  392. } else {
  393. *root_dprc_dev = dev;
  394. while (dev_is_fsl_mc((*root_dprc_dev)->parent))
  395. *root_dprc_dev = (*root_dprc_dev)->parent;
  396. }
  397. }
  398. static int get_dprc_attr(struct fsl_mc_io *mc_io,
  399. int container_id, struct dprc_attributes *attr)
  400. {
  401. u16 dprc_handle;
  402. int error;
  403. error = dprc_open(mc_io, 0, container_id, &dprc_handle);
  404. if (error < 0) {
  405. dev_err(mc_io->dev, "dprc_open() failed: %d\n", error);
  406. return error;
  407. }
  408. memset(attr, 0, sizeof(struct dprc_attributes));
  409. error = dprc_get_attributes(mc_io, 0, dprc_handle, attr);
  410. if (error < 0) {
  411. dev_err(mc_io->dev, "dprc_get_attributes() failed: %d\n",
  412. error);
  413. goto common_cleanup;
  414. }
  415. error = 0;
  416. common_cleanup:
  417. (void)dprc_close(mc_io, 0, dprc_handle);
  418. return error;
  419. }
  420. static int get_dprc_icid(struct fsl_mc_io *mc_io,
  421. int container_id, u32 *icid)
  422. {
  423. struct dprc_attributes attr;
  424. int error;
  425. error = get_dprc_attr(mc_io, container_id, &attr);
  426. if (error == 0)
  427. *icid = attr.icid;
  428. return error;
  429. }
  430. static int translate_mc_addr(struct fsl_mc_device *mc_dev,
  431. enum dprc_region_type mc_region_type,
  432. u64 mc_offset, phys_addr_t *phys_addr)
  433. {
  434. int i;
  435. struct device *root_dprc_dev;
  436. struct fsl_mc *mc;
  437. fsl_mc_get_root_dprc(&mc_dev->dev, &root_dprc_dev);
  438. mc = dev_get_drvdata(root_dprc_dev->parent);
  439. if (mc->num_translation_ranges == 0) {
  440. /*
  441. * Do identity mapping:
  442. */
  443. *phys_addr = mc_offset;
  444. return 0;
  445. }
  446. for (i = 0; i < mc->num_translation_ranges; i++) {
  447. struct fsl_mc_addr_translation_range *range =
  448. &mc->translation_ranges[i];
  449. if (mc_region_type == range->mc_region_type &&
  450. mc_offset >= range->start_mc_offset &&
  451. mc_offset < range->end_mc_offset) {
  452. *phys_addr = range->start_phys_addr +
  453. (mc_offset - range->start_mc_offset);
  454. return 0;
  455. }
  456. }
  457. return -EFAULT;
  458. }
  459. static int fsl_mc_device_get_mmio_regions(struct fsl_mc_device *mc_dev,
  460. struct fsl_mc_device *mc_bus_dev)
  461. {
  462. int i;
  463. int error;
  464. struct resource *regions;
  465. struct fsl_mc_obj_desc *obj_desc = &mc_dev->obj_desc;
  466. struct device *parent_dev = mc_dev->dev.parent;
  467. enum dprc_region_type mc_region_type;
  468. if (is_fsl_mc_bus_dprc(mc_dev) ||
  469. is_fsl_mc_bus_dpmcp(mc_dev)) {
  470. mc_region_type = DPRC_REGION_TYPE_MC_PORTAL;
  471. } else if (is_fsl_mc_bus_dpio(mc_dev)) {
  472. mc_region_type = DPRC_REGION_TYPE_QBMAN_PORTAL;
  473. } else {
  474. /*
  475. * This function should not have been called for this MC object
  476. * type, as this object type is not supposed to have MMIO
  477. * regions
  478. */
  479. return -EINVAL;
  480. }
  481. regions = kmalloc_array(obj_desc->region_count,
  482. sizeof(regions[0]), GFP_KERNEL);
  483. if (!regions)
  484. return -ENOMEM;
  485. for (i = 0; i < obj_desc->region_count; i++) {
  486. struct dprc_region_desc region_desc;
  487. error = dprc_get_obj_region(mc_bus_dev->mc_io,
  488. 0,
  489. mc_bus_dev->mc_handle,
  490. obj_desc->type,
  491. obj_desc->id, i, &region_desc);
  492. if (error < 0) {
  493. dev_err(parent_dev,
  494. "dprc_get_obj_region() failed: %d\n", error);
  495. goto error_cleanup_regions;
  496. }
  497. /*
  498. * Older MC only returned region offset and no base address
  499. * If base address is in the region_desc use it otherwise
  500. * revert to old mechanism
  501. */
  502. if (region_desc.base_address) {
  503. regions[i].start = region_desc.base_address +
  504. region_desc.base_offset;
  505. } else {
  506. error = translate_mc_addr(mc_dev, mc_region_type,
  507. region_desc.base_offset,
  508. &regions[i].start);
  509. /*
  510. * Some versions of the MC firmware wrongly report
  511. * 0 for register base address of the DPMCP associated
  512. * with child DPRC objects thus rendering them unusable.
  513. * This is particularly troublesome in ACPI boot
  514. * scenarios where the legacy way of extracting this
  515. * base address from the device tree does not apply.
  516. * Given that DPMCPs share the same base address,
  517. * workaround this by using the base address extracted
  518. * from the root DPRC container.
  519. */
  520. if (is_fsl_mc_bus_dprc(mc_dev) &&
  521. regions[i].start == region_desc.base_offset)
  522. regions[i].start += mc_portal_base_phys_addr;
  523. }
  524. if (error < 0) {
  525. dev_err(parent_dev,
  526. "Invalid MC offset: %#x (for %s.%d\'s region %d)\n",
  527. region_desc.base_offset,
  528. obj_desc->type, obj_desc->id, i);
  529. goto error_cleanup_regions;
  530. }
  531. regions[i].end = regions[i].start + region_desc.size - 1;
  532. regions[i].name = "fsl-mc object MMIO region";
  533. regions[i].flags = region_desc.flags & IORESOURCE_BITS;
  534. regions[i].flags |= IORESOURCE_MEM;
  535. }
  536. mc_dev->regions = regions;
  537. return 0;
  538. error_cleanup_regions:
  539. kfree(regions);
  540. return error;
  541. }
  542. /**
  543. * fsl_mc_is_root_dprc - function to check if a given device is a root dprc
  544. */
  545. bool fsl_mc_is_root_dprc(struct device *dev)
  546. {
  547. struct device *root_dprc_dev;
  548. fsl_mc_get_root_dprc(dev, &root_dprc_dev);
  549. if (!root_dprc_dev)
  550. return false;
  551. return dev == root_dprc_dev;
  552. }
  553. static void fsl_mc_device_release(struct device *dev)
  554. {
  555. struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
  556. kfree(mc_dev->regions);
  557. if (is_fsl_mc_bus_dprc(mc_dev))
  558. kfree(to_fsl_mc_bus(mc_dev));
  559. else
  560. kfree(mc_dev);
  561. }
  562. /**
  563. * Add a newly discovered fsl-mc device to be visible in Linux
  564. */
  565. int fsl_mc_device_add(struct fsl_mc_obj_desc *obj_desc,
  566. struct fsl_mc_io *mc_io,
  567. struct device *parent_dev,
  568. struct fsl_mc_device **new_mc_dev)
  569. {
  570. int error;
  571. struct fsl_mc_device *mc_dev = NULL;
  572. struct fsl_mc_bus *mc_bus = NULL;
  573. struct fsl_mc_device *parent_mc_dev;
  574. if (dev_is_fsl_mc(parent_dev))
  575. parent_mc_dev = to_fsl_mc_device(parent_dev);
  576. else
  577. parent_mc_dev = NULL;
  578. if (strcmp(obj_desc->type, "dprc") == 0) {
  579. /*
  580. * Allocate an MC bus device object:
  581. */
  582. mc_bus = kzalloc(sizeof(*mc_bus), GFP_KERNEL);
  583. if (!mc_bus)
  584. return -ENOMEM;
  585. mutex_init(&mc_bus->scan_mutex);
  586. mc_dev = &mc_bus->mc_dev;
  587. } else {
  588. /*
  589. * Allocate a regular fsl_mc_device object:
  590. */
  591. mc_dev = kzalloc(sizeof(*mc_dev), GFP_KERNEL);
  592. if (!mc_dev)
  593. return -ENOMEM;
  594. }
  595. mc_dev->obj_desc = *obj_desc;
  596. mc_dev->mc_io = mc_io;
  597. device_initialize(&mc_dev->dev);
  598. mc_dev->dev.parent = parent_dev;
  599. mc_dev->dev.bus = &fsl_mc_bus_type;
  600. mc_dev->dev.release = fsl_mc_device_release;
  601. mc_dev->dev.type = fsl_mc_get_device_type(obj_desc->type);
  602. if (!mc_dev->dev.type) {
  603. error = -ENODEV;
  604. dev_err(parent_dev, "unknown device type %s\n", obj_desc->type);
  605. goto error_cleanup_dev;
  606. }
  607. dev_set_name(&mc_dev->dev, "%s.%d", obj_desc->type, obj_desc->id);
  608. if (strcmp(obj_desc->type, "dprc") == 0) {
  609. struct fsl_mc_io *mc_io2;
  610. mc_dev->flags |= FSL_MC_IS_DPRC;
  611. /*
  612. * To get the DPRC's ICID, we need to open the DPRC
  613. * in get_dprc_icid(). For child DPRCs, we do so using the
  614. * parent DPRC's MC portal instead of the child DPRC's MC
  615. * portal, in case the child DPRC is already opened with
  616. * its own portal (e.g., the DPRC used by AIOP).
  617. *
  618. * NOTE: There cannot be more than one active open for a
  619. * given MC object, using the same MC portal.
  620. */
  621. if (parent_mc_dev) {
  622. /*
  623. * device being added is a child DPRC device
  624. */
  625. mc_io2 = parent_mc_dev->mc_io;
  626. } else {
  627. /*
  628. * device being added is the root DPRC device
  629. */
  630. if (!mc_io) {
  631. error = -EINVAL;
  632. goto error_cleanup_dev;
  633. }
  634. mc_io2 = mc_io;
  635. }
  636. error = get_dprc_icid(mc_io2, obj_desc->id, &mc_dev->icid);
  637. if (error < 0)
  638. goto error_cleanup_dev;
  639. } else {
  640. /*
  641. * A non-DPRC object has to be a child of a DPRC, use the
  642. * parent's ICID and interrupt domain.
  643. */
  644. mc_dev->icid = parent_mc_dev->icid;
  645. mc_dev->dma_mask = FSL_MC_DEFAULT_DMA_MASK;
  646. mc_dev->dev.dma_mask = &mc_dev->dma_mask;
  647. mc_dev->dev.coherent_dma_mask = mc_dev->dma_mask;
  648. dev_set_msi_domain(&mc_dev->dev,
  649. dev_get_msi_domain(&parent_mc_dev->dev));
  650. }
  651. /*
  652. * Get MMIO regions for the device from the MC:
  653. *
  654. * NOTE: the root DPRC is a special case as its MMIO region is
  655. * obtained from the device tree
  656. */
  657. if (parent_mc_dev && obj_desc->region_count != 0) {
  658. error = fsl_mc_device_get_mmio_regions(mc_dev,
  659. parent_mc_dev);
  660. if (error < 0)
  661. goto error_cleanup_dev;
  662. }
  663. /*
  664. * The device-specific probe callback will get invoked by device_add()
  665. */
  666. error = device_add(&mc_dev->dev);
  667. if (error < 0) {
  668. dev_err(parent_dev,
  669. "device_add() failed for device %s: %d\n",
  670. dev_name(&mc_dev->dev), error);
  671. goto error_cleanup_dev;
  672. }
  673. dev_dbg(parent_dev, "added %s\n", dev_name(&mc_dev->dev));
  674. *new_mc_dev = mc_dev;
  675. return 0;
  676. error_cleanup_dev:
  677. kfree(mc_dev->regions);
  678. kfree(mc_bus);
  679. kfree(mc_dev);
  680. return error;
  681. }
  682. EXPORT_SYMBOL_GPL(fsl_mc_device_add);
  683. /**
  684. * fsl_mc_device_remove - Remove an fsl-mc device from being visible to
  685. * Linux
  686. *
  687. * @mc_dev: Pointer to an fsl-mc device
  688. */
  689. void fsl_mc_device_remove(struct fsl_mc_device *mc_dev)
  690. {
  691. kfree(mc_dev->driver_override);
  692. mc_dev->driver_override = NULL;
  693. /*
  694. * The device-specific remove callback will get invoked by device_del()
  695. */
  696. device_del(&mc_dev->dev);
  697. put_device(&mc_dev->dev);
  698. }
  699. EXPORT_SYMBOL_GPL(fsl_mc_device_remove);
  700. struct fsl_mc_device *fsl_mc_get_endpoint(struct fsl_mc_device *mc_dev)
  701. {
  702. struct fsl_mc_device *mc_bus_dev, *endpoint;
  703. struct fsl_mc_obj_desc endpoint_desc = {{ 0 }};
  704. struct dprc_endpoint endpoint1 = {{ 0 }};
  705. struct dprc_endpoint endpoint2 = {{ 0 }};
  706. int state, err;
  707. mc_bus_dev = to_fsl_mc_device(mc_dev->dev.parent);
  708. strcpy(endpoint1.type, mc_dev->obj_desc.type);
  709. endpoint1.id = mc_dev->obj_desc.id;
  710. err = dprc_get_connection(mc_bus_dev->mc_io, 0,
  711. mc_bus_dev->mc_handle,
  712. &endpoint1, &endpoint2,
  713. &state);
  714. if (err == -ENOTCONN || state == -1)
  715. return ERR_PTR(-ENOTCONN);
  716. if (err < 0) {
  717. dev_err(&mc_bus_dev->dev, "dprc_get_connection() = %d\n", err);
  718. return ERR_PTR(err);
  719. }
  720. strcpy(endpoint_desc.type, endpoint2.type);
  721. endpoint_desc.id = endpoint2.id;
  722. endpoint = fsl_mc_device_lookup(&endpoint_desc, mc_bus_dev);
  723. return endpoint;
  724. }
  725. EXPORT_SYMBOL_GPL(fsl_mc_get_endpoint);
  726. static int parse_mc_ranges(struct device *dev,
  727. int *paddr_cells,
  728. int *mc_addr_cells,
  729. int *mc_size_cells,
  730. const __be32 **ranges_start)
  731. {
  732. const __be32 *prop;
  733. int range_tuple_cell_count;
  734. int ranges_len;
  735. int tuple_len;
  736. struct device_node *mc_node = dev->of_node;
  737. *ranges_start = of_get_property(mc_node, "ranges", &ranges_len);
  738. if (!(*ranges_start) || !ranges_len) {
  739. dev_warn(dev,
  740. "missing or empty ranges property for device tree node '%pOFn'\n",
  741. mc_node);
  742. return 0;
  743. }
  744. *paddr_cells = of_n_addr_cells(mc_node);
  745. prop = of_get_property(mc_node, "#address-cells", NULL);
  746. if (prop)
  747. *mc_addr_cells = be32_to_cpup(prop);
  748. else
  749. *mc_addr_cells = *paddr_cells;
  750. prop = of_get_property(mc_node, "#size-cells", NULL);
  751. if (prop)
  752. *mc_size_cells = be32_to_cpup(prop);
  753. else
  754. *mc_size_cells = of_n_size_cells(mc_node);
  755. range_tuple_cell_count = *paddr_cells + *mc_addr_cells +
  756. *mc_size_cells;
  757. tuple_len = range_tuple_cell_count * sizeof(__be32);
  758. if (ranges_len % tuple_len != 0) {
  759. dev_err(dev, "malformed ranges property '%pOFn'\n", mc_node);
  760. return -EINVAL;
  761. }
  762. return ranges_len / tuple_len;
  763. }
  764. static int get_mc_addr_translation_ranges(struct device *dev,
  765. struct fsl_mc_addr_translation_range
  766. **ranges,
  767. u8 *num_ranges)
  768. {
  769. int ret;
  770. int paddr_cells;
  771. int mc_addr_cells;
  772. int mc_size_cells;
  773. int i;
  774. const __be32 *ranges_start;
  775. const __be32 *cell;
  776. ret = parse_mc_ranges(dev,
  777. &paddr_cells,
  778. &mc_addr_cells,
  779. &mc_size_cells,
  780. &ranges_start);
  781. if (ret < 0)
  782. return ret;
  783. *num_ranges = ret;
  784. if (!ret) {
  785. /*
  786. * Missing or empty ranges property ("ranges;") for the
  787. * 'fsl,qoriq-mc' node. In this case, identity mapping
  788. * will be used.
  789. */
  790. *ranges = NULL;
  791. return 0;
  792. }
  793. *ranges = devm_kcalloc(dev, *num_ranges,
  794. sizeof(struct fsl_mc_addr_translation_range),
  795. GFP_KERNEL);
  796. if (!(*ranges))
  797. return -ENOMEM;
  798. cell = ranges_start;
  799. for (i = 0; i < *num_ranges; ++i) {
  800. struct fsl_mc_addr_translation_range *range = &(*ranges)[i];
  801. range->mc_region_type = of_read_number(cell, 1);
  802. range->start_mc_offset = of_read_number(cell + 1,
  803. mc_addr_cells - 1);
  804. cell += mc_addr_cells;
  805. range->start_phys_addr = of_read_number(cell, paddr_cells);
  806. cell += paddr_cells;
  807. range->end_mc_offset = range->start_mc_offset +
  808. of_read_number(cell, mc_size_cells);
  809. cell += mc_size_cells;
  810. }
  811. return 0;
  812. }
  813. /**
  814. * fsl_mc_bus_probe - callback invoked when the root MC bus is being
  815. * added
  816. */
  817. static int fsl_mc_bus_probe(struct platform_device *pdev)
  818. {
  819. struct fsl_mc_obj_desc obj_desc;
  820. int error;
  821. struct fsl_mc *mc;
  822. struct fsl_mc_device *mc_bus_dev = NULL;
  823. struct fsl_mc_io *mc_io = NULL;
  824. int container_id;
  825. phys_addr_t mc_portal_phys_addr;
  826. u32 mc_portal_size, mc_stream_id;
  827. struct resource *plat_res;
  828. mc = devm_kzalloc(&pdev->dev, sizeof(*mc), GFP_KERNEL);
  829. if (!mc)
  830. return -ENOMEM;
  831. platform_set_drvdata(pdev, mc);
  832. plat_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
  833. if (plat_res) {
  834. mc->fsl_mc_regs = devm_ioremap_resource(&pdev->dev, plat_res);
  835. if (IS_ERR(mc->fsl_mc_regs))
  836. return PTR_ERR(mc->fsl_mc_regs);
  837. }
  838. if (mc->fsl_mc_regs && IS_ENABLED(CONFIG_ACPI) &&
  839. !dev_of_node(&pdev->dev)) {
  840. mc_stream_id = readl(mc->fsl_mc_regs + FSL_MC_FAPR);
  841. /*
  842. * HW ORs the PL and BMT bit, places the result in bit 15 of
  843. * the StreamID and ORs in the ICID. Calculate it accordingly.
  844. */
  845. mc_stream_id = (mc_stream_id & 0xffff) |
  846. ((mc_stream_id & (MC_FAPR_PL | MC_FAPR_BMT)) ?
  847. 0x4000 : 0);
  848. error = acpi_dma_configure_id(&pdev->dev, DEV_DMA_COHERENT,
  849. &mc_stream_id);
  850. if (error)
  851. dev_warn(&pdev->dev, "failed to configure dma: %d.\n",
  852. error);
  853. }
  854. /*
  855. * Get physical address of MC portal for the root DPRC:
  856. */
  857. plat_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  858. mc_portal_phys_addr = plat_res->start;
  859. mc_portal_size = resource_size(plat_res);
  860. mc_portal_base_phys_addr = mc_portal_phys_addr & ~0x3ffffff;
  861. error = fsl_create_mc_io(&pdev->dev, mc_portal_phys_addr,
  862. mc_portal_size, NULL,
  863. FSL_MC_IO_ATOMIC_CONTEXT_PORTAL, &mc_io);
  864. if (error < 0)
  865. return error;
  866. error = mc_get_version(mc_io, 0, &mc_version);
  867. if (error != 0) {
  868. dev_err(&pdev->dev,
  869. "mc_get_version() failed with error %d\n", error);
  870. goto error_cleanup_mc_io;
  871. }
  872. dev_info(&pdev->dev, "MC firmware version: %u.%u.%u\n",
  873. mc_version.major, mc_version.minor, mc_version.revision);
  874. if (dev_of_node(&pdev->dev)) {
  875. error = get_mc_addr_translation_ranges(&pdev->dev,
  876. &mc->translation_ranges,
  877. &mc->num_translation_ranges);
  878. if (error < 0)
  879. goto error_cleanup_mc_io;
  880. }
  881. error = dprc_get_container_id(mc_io, 0, &container_id);
  882. if (error < 0) {
  883. dev_err(&pdev->dev,
  884. "dprc_get_container_id() failed: %d\n", error);
  885. goto error_cleanup_mc_io;
  886. }
  887. memset(&obj_desc, 0, sizeof(struct fsl_mc_obj_desc));
  888. error = dprc_get_api_version(mc_io, 0,
  889. &obj_desc.ver_major,
  890. &obj_desc.ver_minor);
  891. if (error < 0)
  892. goto error_cleanup_mc_io;
  893. obj_desc.vendor = FSL_MC_VENDOR_FREESCALE;
  894. strcpy(obj_desc.type, "dprc");
  895. obj_desc.id = container_id;
  896. obj_desc.irq_count = 1;
  897. obj_desc.region_count = 0;
  898. error = fsl_mc_device_add(&obj_desc, mc_io, &pdev->dev, &mc_bus_dev);
  899. if (error < 0)
  900. goto error_cleanup_mc_io;
  901. mc->root_mc_bus_dev = mc_bus_dev;
  902. mc_bus_dev->dev.fwnode = pdev->dev.fwnode;
  903. return 0;
  904. error_cleanup_mc_io:
  905. fsl_destroy_mc_io(mc_io);
  906. return error;
  907. }
  908. /**
  909. * fsl_mc_bus_remove - callback invoked when the root MC bus is being
  910. * removed
  911. */
  912. static int fsl_mc_bus_remove(struct platform_device *pdev)
  913. {
  914. struct fsl_mc *mc = platform_get_drvdata(pdev);
  915. if (!fsl_mc_is_root_dprc(&mc->root_mc_bus_dev->dev))
  916. return -EINVAL;
  917. fsl_mc_device_remove(mc->root_mc_bus_dev);
  918. fsl_destroy_mc_io(mc->root_mc_bus_dev->mc_io);
  919. mc->root_mc_bus_dev->mc_io = NULL;
  920. return 0;
  921. }
  922. static const struct of_device_id fsl_mc_bus_match_table[] = {
  923. {.compatible = "fsl,qoriq-mc",},
  924. {},
  925. };
  926. MODULE_DEVICE_TABLE(of, fsl_mc_bus_match_table);
  927. static const struct acpi_device_id fsl_mc_bus_acpi_match_table[] = {
  928. {"NXP0008", 0 },
  929. { }
  930. };
  931. MODULE_DEVICE_TABLE(acpi, fsl_mc_bus_acpi_match_table);
  932. static struct platform_driver fsl_mc_bus_driver = {
  933. .driver = {
  934. .name = "fsl_mc_bus",
  935. .pm = NULL,
  936. .of_match_table = fsl_mc_bus_match_table,
  937. .acpi_match_table = fsl_mc_bus_acpi_match_table,
  938. },
  939. .probe = fsl_mc_bus_probe,
  940. .remove = fsl_mc_bus_remove,
  941. };
  942. static int __init fsl_mc_bus_driver_init(void)
  943. {
  944. int error;
  945. error = bus_register(&fsl_mc_bus_type);
  946. if (error < 0) {
  947. pr_err("bus type registration failed: %d\n", error);
  948. goto error_cleanup_cache;
  949. }
  950. error = platform_driver_register(&fsl_mc_bus_driver);
  951. if (error < 0) {
  952. pr_err("platform_driver_register() failed: %d\n", error);
  953. goto error_cleanup_bus;
  954. }
  955. error = dprc_driver_init();
  956. if (error < 0)
  957. goto error_cleanup_driver;
  958. error = fsl_mc_allocator_driver_init();
  959. if (error < 0)
  960. goto error_cleanup_dprc_driver;
  961. return 0;
  962. error_cleanup_dprc_driver:
  963. dprc_driver_exit();
  964. error_cleanup_driver:
  965. platform_driver_unregister(&fsl_mc_bus_driver);
  966. error_cleanup_bus:
  967. bus_unregister(&fsl_mc_bus_type);
  968. error_cleanup_cache:
  969. return error;
  970. }
  971. postcore_initcall(fsl_mc_bus_driver_init);