apple-dart.c 37 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Apple DART (Device Address Resolution Table) IOMMU driver
  4. *
  5. * Copyright (C) 2021 The Asahi Linux Contributors
  6. *
  7. * Based on arm/arm-smmu/arm-ssmu.c and arm/arm-smmu-v3/arm-smmu-v3.c
  8. * Copyright (C) 2013 ARM Limited
  9. * Copyright (C) 2015 ARM Limited
  10. * and on exynos-iommu.c
  11. * Copyright (c) 2011,2016 Samsung Electronics Co., Ltd.
  12. */
  13. #include <linux/atomic.h>
  14. #include <linux/bitfield.h>
  15. #include <linux/clk.h>
  16. #include <linux/dev_printk.h>
  17. #include <linux/dma-mapping.h>
  18. #include <linux/err.h>
  19. #include <linux/interrupt.h>
  20. #include <linux/io-pgtable.h>
  21. #include <linux/iommu.h>
  22. #include <linux/iopoll.h>
  23. #include <linux/module.h>
  24. #include <linux/of.h>
  25. #include <linux/of_address.h>
  26. #include <linux/of_iommu.h>
  27. #include <linux/of_platform.h>
  28. #include <linux/pci.h>
  29. #include <linux/platform_device.h>
  30. #include <linux/slab.h>
  31. #include <linux/swab.h>
  32. #include <linux/types.h>
  33. #include "dma-iommu.h"
  34. #define DART_MAX_STREAMS 256
  35. #define DART_MAX_TTBR 4
  36. #define MAX_DARTS_PER_DEVICE 3
  37. /* Common registers */
  38. #define DART_PARAMS1 0x00
  39. #define DART_PARAMS1_PAGE_SHIFT GENMASK(27, 24)
  40. #define DART_PARAMS2 0x04
  41. #define DART_PARAMS2_BYPASS_SUPPORT BIT(0)
  42. /* T8020/T6000 registers */
  43. #define DART_T8020_STREAM_COMMAND 0x20
  44. #define DART_T8020_STREAM_COMMAND_BUSY BIT(2)
  45. #define DART_T8020_STREAM_COMMAND_INVALIDATE BIT(20)
  46. #define DART_T8020_STREAM_SELECT 0x34
  47. #define DART_T8020_ERROR 0x40
  48. #define DART_T8020_ERROR_STREAM GENMASK(27, 24)
  49. #define DART_T8020_ERROR_CODE GENMASK(11, 0)
  50. #define DART_T8020_ERROR_FLAG BIT(31)
  51. #define DART_T8020_ERROR_READ_FAULT BIT(4)
  52. #define DART_T8020_ERROR_WRITE_FAULT BIT(3)
  53. #define DART_T8020_ERROR_NO_PTE BIT(2)
  54. #define DART_T8020_ERROR_NO_PMD BIT(1)
  55. #define DART_T8020_ERROR_NO_TTBR BIT(0)
  56. #define DART_T8020_CONFIG 0x60
  57. #define DART_T8020_CONFIG_LOCK BIT(15)
  58. #define DART_STREAM_COMMAND_BUSY_TIMEOUT 100
  59. #define DART_T8020_ERROR_ADDR_HI 0x54
  60. #define DART_T8020_ERROR_ADDR_LO 0x50
  61. #define DART_T8020_STREAMS_ENABLE 0xfc
  62. #define DART_T8020_TCR 0x100
  63. #define DART_T8020_TCR_TRANSLATE_ENABLE BIT(7)
  64. #define DART_T8020_TCR_BYPASS_DART BIT(8)
  65. #define DART_T8020_TCR_BYPASS_DAPF BIT(12)
  66. #define DART_T8020_TTBR 0x200
  67. #define DART_T8020_USB4_TTBR 0x400
  68. #define DART_T8020_TTBR_VALID BIT(31)
  69. #define DART_T8020_TTBR_ADDR_FIELD_SHIFT 0
  70. #define DART_T8020_TTBR_SHIFT 12
  71. /* T8110 registers */
  72. #define DART_T8110_PARAMS3 0x08
  73. #define DART_T8110_PARAMS3_PA_WIDTH GENMASK(29, 24)
  74. #define DART_T8110_PARAMS3_VA_WIDTH GENMASK(21, 16)
  75. #define DART_T8110_PARAMS3_VER_MAJ GENMASK(15, 8)
  76. #define DART_T8110_PARAMS3_VER_MIN GENMASK(7, 0)
  77. #define DART_T8110_PARAMS4 0x0c
  78. #define DART_T8110_PARAMS4_NUM_CLIENTS GENMASK(24, 16)
  79. #define DART_T8110_PARAMS4_NUM_SIDS GENMASK(8, 0)
  80. #define DART_T8110_TLB_CMD 0x80
  81. #define DART_T8110_TLB_CMD_BUSY BIT(31)
  82. #define DART_T8110_TLB_CMD_OP GENMASK(10, 8)
  83. #define DART_T8110_TLB_CMD_OP_FLUSH_ALL 0
  84. #define DART_T8110_TLB_CMD_OP_FLUSH_SID 1
  85. #define DART_T8110_TLB_CMD_STREAM GENMASK(7, 0)
  86. #define DART_T8110_ERROR 0x100
  87. #define DART_T8110_ERROR_STREAM GENMASK(27, 20)
  88. #define DART_T8110_ERROR_CODE GENMASK(14, 0)
  89. #define DART_T8110_ERROR_FLAG BIT(31)
  90. #define DART_T8110_ERROR_MASK 0x104
  91. #define DART_T8110_ERROR_READ_FAULT BIT(5)
  92. #define DART_T8110_ERROR_WRITE_FAULT BIT(4)
  93. #define DART_T8110_ERROR_NO_PTE BIT(3)
  94. #define DART_T8110_ERROR_NO_PMD BIT(2)
  95. #define DART_T8110_ERROR_NO_PGD BIT(1)
  96. #define DART_T8110_ERROR_NO_TTBR BIT(0)
  97. #define DART_T8110_ERROR_ADDR_LO 0x170
  98. #define DART_T8110_ERROR_ADDR_HI 0x174
  99. #define DART_T8110_ERROR_STREAMS 0x1c0
  100. #define DART_T8110_PROTECT 0x200
  101. #define DART_T8110_UNPROTECT 0x204
  102. #define DART_T8110_PROTECT_LOCK 0x208
  103. #define DART_T8110_PROTECT_TTBR_TCR BIT(0)
  104. #define DART_T8110_ENABLE_STREAMS 0xc00
  105. #define DART_T8110_DISABLE_STREAMS 0xc20
  106. #define DART_T8110_TCR 0x1000
  107. #define DART_T8110_TCR_REMAP GENMASK(11, 8)
  108. #define DART_T8110_TCR_REMAP_EN BIT(7)
  109. #define DART_T8110_TCR_FOUR_LEVEL BIT(3)
  110. #define DART_T8110_TCR_BYPASS_DAPF BIT(2)
  111. #define DART_T8110_TCR_BYPASS_DART BIT(1)
  112. #define DART_T8110_TCR_TRANSLATE_ENABLE BIT(0)
  113. #define DART_T8110_TTBR 0x1400
  114. #define DART_T8110_TTBR_VALID BIT(0)
  115. #define DART_T8110_TTBR_ADDR_FIELD_SHIFT 2
  116. #define DART_T8110_TTBR_SHIFT 14
  117. #define DART_TCR(dart, sid) ((dart)->hw->tcr + ((sid) << 2))
  118. #define DART_TTBR(dart, sid, idx) ((dart)->hw->ttbr + \
  119. (((dart)->hw->ttbr_count * (sid)) << 2) + \
  120. ((idx) << 2))
  121. struct apple_dart_stream_map;
  122. enum dart_type {
  123. DART_T8020,
  124. DART_T6000,
  125. DART_T8110,
  126. };
  127. struct apple_dart_hw {
  128. enum dart_type type;
  129. irqreturn_t (*irq_handler)(int irq, void *dev);
  130. int (*invalidate_tlb)(struct apple_dart_stream_map *stream_map);
  131. u32 oas;
  132. enum io_pgtable_fmt fmt;
  133. int max_sid_count;
  134. u32 lock;
  135. u32 lock_bit;
  136. u32 error;
  137. u32 enable_streams;
  138. u32 tcr;
  139. u32 tcr_enabled;
  140. u32 tcr_disabled;
  141. u32 tcr_bypass;
  142. u32 tcr_4level;
  143. u32 ttbr;
  144. u32 ttbr_valid;
  145. u32 ttbr_addr_field_shift;
  146. u32 ttbr_shift;
  147. int ttbr_count;
  148. };
  149. /*
  150. * Private structure associated with each DART device.
  151. *
  152. * @dev: device struct
  153. * @hw: SoC-specific hardware data
  154. * @regs: mapped MMIO region
  155. * @irq: interrupt number, can be shared with other DARTs
  156. * @clks: clocks associated with this DART
  157. * @num_clks: number of @clks
  158. * @lock: lock for hardware operations involving this dart
  159. * @pgsize: pagesize supported by this DART
  160. * @supports_bypass: indicates if this DART supports bypass mode
  161. * @sid2group: maps stream ids to iommu_groups
  162. * @iommu: iommu core device
  163. */
  164. struct apple_dart {
  165. struct device *dev;
  166. const struct apple_dart_hw *hw;
  167. void __iomem *regs;
  168. int irq;
  169. struct clk_bulk_data *clks;
  170. int num_clks;
  171. spinlock_t lock;
  172. u32 ias;
  173. u32 oas;
  174. u32 pgsize;
  175. u32 num_streams;
  176. u32 supports_bypass : 1;
  177. u32 four_level : 1;
  178. struct iommu_group *sid2group[DART_MAX_STREAMS];
  179. struct iommu_device iommu;
  180. u32 save_tcr[DART_MAX_STREAMS];
  181. u32 save_ttbr[DART_MAX_STREAMS][DART_MAX_TTBR];
  182. };
  183. /*
  184. * Convenience struct to identify streams.
  185. *
  186. * The normal variant is used inside apple_dart_master_cfg which isn't written
  187. * to concurrently.
  188. * The atomic variant is used inside apple_dart_domain where we have to guard
  189. * against races from potential parallel calls to attach/detach_device.
  190. * Note that even inside the atomic variant the apple_dart pointer is not
  191. * protected: This pointer is initialized once under the domain init mutex
  192. * and never changed again afterwards. Devices with different dart pointers
  193. * cannot be attached to the same domain.
  194. *
  195. * @dart dart pointer
  196. * @sid stream id bitmap
  197. */
  198. struct apple_dart_stream_map {
  199. struct apple_dart *dart;
  200. DECLARE_BITMAP(sidmap, DART_MAX_STREAMS);
  201. };
  202. struct apple_dart_atomic_stream_map {
  203. struct apple_dart *dart;
  204. atomic_long_t sidmap[BITS_TO_LONGS(DART_MAX_STREAMS)];
  205. };
  206. /*
  207. * This structure is attached to each iommu domain handled by a DART.
  208. *
  209. * @pgtbl_ops: pagetable ops allocated by io-pgtable
  210. * @finalized: true if the domain has been completely initialized
  211. * @init_lock: protects domain initialization
  212. * @stream_maps: streams attached to this domain (valid for DMA/UNMANAGED only)
  213. * @domain: core iommu domain pointer
  214. */
  215. struct apple_dart_domain {
  216. struct io_pgtable_ops *pgtbl_ops;
  217. bool finalized;
  218. struct mutex init_lock;
  219. struct apple_dart_atomic_stream_map stream_maps[MAX_DARTS_PER_DEVICE];
  220. struct iommu_domain domain;
  221. };
  222. /*
  223. * This structure is attached to devices with dev_iommu_priv_set() on of_xlate
  224. * and contains a list of streams bound to this device.
  225. * So far the worst case seen is a single device with two streams
  226. * from different darts, such that this simple static array is enough.
  227. *
  228. * @streams: streams for this device
  229. */
  230. struct apple_dart_master_cfg {
  231. /* Intersection of DART capabilitles */
  232. u32 supports_bypass : 1;
  233. struct apple_dart_stream_map stream_maps[MAX_DARTS_PER_DEVICE];
  234. };
  235. /*
  236. * Helper macro to iterate over apple_dart_master_cfg.stream_maps and
  237. * apple_dart_domain.stream_maps
  238. *
  239. * @i int used as loop variable
  240. * @base pointer to base struct (apple_dart_master_cfg or apple_dart_domain)
  241. * @stream pointer to the apple_dart_streams struct for each loop iteration
  242. */
  243. #define for_each_stream_map(i, base, stream_map) \
  244. for (i = 0, stream_map = &(base)->stream_maps[0]; \
  245. i < MAX_DARTS_PER_DEVICE && stream_map->dart; \
  246. stream_map = &(base)->stream_maps[++i])
  247. static struct platform_driver apple_dart_driver;
  248. static const struct iommu_ops apple_dart_iommu_ops;
  249. static struct apple_dart_domain *to_dart_domain(struct iommu_domain *dom)
  250. {
  251. return container_of(dom, struct apple_dart_domain, domain);
  252. }
  253. static void
  254. apple_dart_hw_enable_translation(struct apple_dart_stream_map *stream_map, int levels)
  255. {
  256. struct apple_dart *dart = stream_map->dart;
  257. u32 tcr = dart->hw->tcr_enabled;
  258. int sid;
  259. if (levels == 4)
  260. tcr |= dart->hw->tcr_4level;
  261. WARN_ON(levels != 3 && levels != 4);
  262. WARN_ON(levels == 4 && !dart->four_level);
  263. for_each_set_bit(sid, stream_map->sidmap, dart->num_streams)
  264. writel(tcr, dart->regs + DART_TCR(dart, sid));
  265. }
  266. static void apple_dart_hw_disable_dma(struct apple_dart_stream_map *stream_map)
  267. {
  268. struct apple_dart *dart = stream_map->dart;
  269. int sid;
  270. for_each_set_bit(sid, stream_map->sidmap, dart->num_streams)
  271. writel(dart->hw->tcr_disabled, dart->regs + DART_TCR(dart, sid));
  272. }
  273. static void
  274. apple_dart_hw_enable_bypass(struct apple_dart_stream_map *stream_map)
  275. {
  276. struct apple_dart *dart = stream_map->dart;
  277. int sid;
  278. WARN_ON(!stream_map->dart->supports_bypass);
  279. for_each_set_bit(sid, stream_map->sidmap, dart->num_streams)
  280. writel(dart->hw->tcr_bypass,
  281. dart->regs + DART_TCR(dart, sid));
  282. }
  283. static void apple_dart_hw_set_ttbr(struct apple_dart_stream_map *stream_map,
  284. u8 idx, phys_addr_t paddr)
  285. {
  286. struct apple_dart *dart = stream_map->dart;
  287. int sid;
  288. WARN_ON(paddr & ((1 << dart->hw->ttbr_shift) - 1));
  289. for_each_set_bit(sid, stream_map->sidmap, dart->num_streams)
  290. writel(dart->hw->ttbr_valid |
  291. (paddr >> dart->hw->ttbr_shift) << dart->hw->ttbr_addr_field_shift,
  292. dart->regs + DART_TTBR(dart, sid, idx));
  293. }
  294. static void apple_dart_hw_clear_ttbr(struct apple_dart_stream_map *stream_map,
  295. u8 idx)
  296. {
  297. struct apple_dart *dart = stream_map->dart;
  298. int sid;
  299. for_each_set_bit(sid, stream_map->sidmap, dart->num_streams)
  300. writel(0, dart->regs + DART_TTBR(dart, sid, idx));
  301. }
  302. static void
  303. apple_dart_hw_clear_all_ttbrs(struct apple_dart_stream_map *stream_map)
  304. {
  305. int i;
  306. for (i = 0; i < stream_map->dart->hw->ttbr_count; ++i)
  307. apple_dart_hw_clear_ttbr(stream_map, i);
  308. }
  309. static int
  310. apple_dart_t8020_hw_stream_command(struct apple_dart_stream_map *stream_map,
  311. u32 command)
  312. {
  313. unsigned long flags;
  314. int ret, i;
  315. u32 command_reg;
  316. spin_lock_irqsave(&stream_map->dart->lock, flags);
  317. for (i = 0; i < BITS_TO_U32(stream_map->dart->num_streams); i++)
  318. writel(stream_map->sidmap[i],
  319. stream_map->dart->regs + DART_T8020_STREAM_SELECT + 4 * i);
  320. writel(command, stream_map->dart->regs + DART_T8020_STREAM_COMMAND);
  321. ret = readl_poll_timeout_atomic(
  322. stream_map->dart->regs + DART_T8020_STREAM_COMMAND, command_reg,
  323. !(command_reg & DART_T8020_STREAM_COMMAND_BUSY), 1,
  324. DART_STREAM_COMMAND_BUSY_TIMEOUT);
  325. spin_unlock_irqrestore(&stream_map->dart->lock, flags);
  326. if (ret) {
  327. dev_err(stream_map->dart->dev,
  328. "busy bit did not clear after command %x for streams %lx\n",
  329. command, stream_map->sidmap[0]);
  330. return ret;
  331. }
  332. return 0;
  333. }
  334. static int
  335. apple_dart_t8110_hw_tlb_command(struct apple_dart_stream_map *stream_map,
  336. u32 command)
  337. {
  338. struct apple_dart *dart = stream_map->dart;
  339. unsigned long flags;
  340. int ret = 0;
  341. int sid;
  342. spin_lock_irqsave(&dart->lock, flags);
  343. for_each_set_bit(sid, stream_map->sidmap, dart->num_streams) {
  344. u32 val = FIELD_PREP(DART_T8110_TLB_CMD_OP, command) |
  345. FIELD_PREP(DART_T8110_TLB_CMD_STREAM, sid);
  346. writel(val, dart->regs + DART_T8110_TLB_CMD);
  347. ret = readl_poll_timeout_atomic(
  348. dart->regs + DART_T8110_TLB_CMD, val,
  349. !(val & DART_T8110_TLB_CMD_BUSY), 1,
  350. DART_STREAM_COMMAND_BUSY_TIMEOUT);
  351. if (ret)
  352. break;
  353. }
  354. spin_unlock_irqrestore(&dart->lock, flags);
  355. if (ret) {
  356. dev_err(stream_map->dart->dev,
  357. "busy bit did not clear after command %x for stream %d\n",
  358. command, sid);
  359. return ret;
  360. }
  361. return 0;
  362. }
  363. static int
  364. apple_dart_t8020_hw_invalidate_tlb(struct apple_dart_stream_map *stream_map)
  365. {
  366. return apple_dart_t8020_hw_stream_command(
  367. stream_map, DART_T8020_STREAM_COMMAND_INVALIDATE);
  368. }
  369. static int
  370. apple_dart_t8110_hw_invalidate_tlb(struct apple_dart_stream_map *stream_map)
  371. {
  372. return apple_dart_t8110_hw_tlb_command(
  373. stream_map, DART_T8110_TLB_CMD_OP_FLUSH_SID);
  374. }
  375. static int apple_dart_hw_reset(struct apple_dart *dart)
  376. {
  377. u32 config;
  378. struct apple_dart_stream_map stream_map;
  379. int i;
  380. config = readl(dart->regs + dart->hw->lock);
  381. if (config & dart->hw->lock_bit) {
  382. dev_err(dart->dev, "DART is locked down until reboot: %08x\n",
  383. config);
  384. return -EINVAL;
  385. }
  386. stream_map.dart = dart;
  387. bitmap_zero(stream_map.sidmap, DART_MAX_STREAMS);
  388. bitmap_set(stream_map.sidmap, 0, dart->num_streams);
  389. apple_dart_hw_disable_dma(&stream_map);
  390. apple_dart_hw_clear_all_ttbrs(&stream_map);
  391. /* enable all streams globally since TCR is used to control isolation */
  392. for (i = 0; i < BITS_TO_U32(dart->num_streams); i++)
  393. writel(U32_MAX, dart->regs + dart->hw->enable_streams + 4 * i);
  394. /* clear any pending errors before the interrupt is unmasked */
  395. writel(readl(dart->regs + dart->hw->error), dart->regs + dart->hw->error);
  396. if (dart->hw->type == DART_T8110)
  397. writel(0, dart->regs + DART_T8110_ERROR_MASK);
  398. return dart->hw->invalidate_tlb(&stream_map);
  399. }
  400. static void apple_dart_domain_flush_tlb(struct apple_dart_domain *domain)
  401. {
  402. int i, j;
  403. struct apple_dart_atomic_stream_map *domain_stream_map;
  404. struct apple_dart_stream_map stream_map;
  405. for_each_stream_map(i, domain, domain_stream_map) {
  406. stream_map.dart = domain_stream_map->dart;
  407. for (j = 0; j < BITS_TO_LONGS(stream_map.dart->num_streams); j++)
  408. stream_map.sidmap[j] = atomic_long_read(&domain_stream_map->sidmap[j]);
  409. stream_map.dart->hw->invalidate_tlb(&stream_map);
  410. }
  411. }
  412. static void apple_dart_flush_iotlb_all(struct iommu_domain *domain)
  413. {
  414. apple_dart_domain_flush_tlb(to_dart_domain(domain));
  415. }
  416. static void apple_dart_iotlb_sync(struct iommu_domain *domain,
  417. struct iommu_iotlb_gather *gather)
  418. {
  419. apple_dart_domain_flush_tlb(to_dart_domain(domain));
  420. }
  421. static int apple_dart_iotlb_sync_map(struct iommu_domain *domain,
  422. unsigned long iova, size_t size)
  423. {
  424. apple_dart_domain_flush_tlb(to_dart_domain(domain));
  425. return 0;
  426. }
  427. static phys_addr_t apple_dart_iova_to_phys(struct iommu_domain *domain,
  428. dma_addr_t iova)
  429. {
  430. struct apple_dart_domain *dart_domain = to_dart_domain(domain);
  431. struct io_pgtable_ops *ops = dart_domain->pgtbl_ops;
  432. if (!ops)
  433. return 0;
  434. return ops->iova_to_phys(ops, iova);
  435. }
  436. static int apple_dart_map_pages(struct iommu_domain *domain, unsigned long iova,
  437. phys_addr_t paddr, size_t pgsize,
  438. size_t pgcount, int prot, gfp_t gfp,
  439. size_t *mapped)
  440. {
  441. struct apple_dart_domain *dart_domain = to_dart_domain(domain);
  442. struct io_pgtable_ops *ops = dart_domain->pgtbl_ops;
  443. if (!ops)
  444. return -ENODEV;
  445. return ops->map_pages(ops, iova, paddr, pgsize, pgcount, prot, gfp,
  446. mapped);
  447. }
  448. static size_t apple_dart_unmap_pages(struct iommu_domain *domain,
  449. unsigned long iova, size_t pgsize,
  450. size_t pgcount,
  451. struct iommu_iotlb_gather *gather)
  452. {
  453. struct apple_dart_domain *dart_domain = to_dart_domain(domain);
  454. struct io_pgtable_ops *ops = dart_domain->pgtbl_ops;
  455. return ops->unmap_pages(ops, iova, pgsize, pgcount, gather);
  456. }
  457. static void
  458. apple_dart_setup_translation(struct apple_dart_domain *domain,
  459. struct apple_dart_stream_map *stream_map)
  460. {
  461. int i;
  462. struct io_pgtable_cfg *pgtbl_cfg =
  463. &io_pgtable_ops_to_pgtable(domain->pgtbl_ops)->cfg;
  464. for (i = 0; i < pgtbl_cfg->apple_dart_cfg.n_ttbrs; ++i)
  465. apple_dart_hw_set_ttbr(stream_map, i,
  466. pgtbl_cfg->apple_dart_cfg.ttbr[i]);
  467. for (; i < stream_map->dart->hw->ttbr_count; ++i)
  468. apple_dart_hw_clear_ttbr(stream_map, i);
  469. apple_dart_hw_enable_translation(stream_map,
  470. pgtbl_cfg->apple_dart_cfg.n_levels);
  471. stream_map->dart->hw->invalidate_tlb(stream_map);
  472. }
  473. static int apple_dart_finalize_domain(struct apple_dart_domain *dart_domain,
  474. struct apple_dart_master_cfg *cfg)
  475. {
  476. struct apple_dart *dart = cfg->stream_maps[0].dart;
  477. struct io_pgtable_cfg pgtbl_cfg;
  478. int ret = 0;
  479. int i, j;
  480. if (dart->pgsize > PAGE_SIZE)
  481. return -EINVAL;
  482. mutex_lock(&dart_domain->init_lock);
  483. if (dart_domain->finalized)
  484. goto done;
  485. for (i = 0; i < MAX_DARTS_PER_DEVICE; ++i) {
  486. dart_domain->stream_maps[i].dart = cfg->stream_maps[i].dart;
  487. for (j = 0; j < BITS_TO_LONGS(dart->num_streams); j++)
  488. atomic_long_set(&dart_domain->stream_maps[i].sidmap[j],
  489. cfg->stream_maps[i].sidmap[j]);
  490. }
  491. pgtbl_cfg = (struct io_pgtable_cfg){
  492. .pgsize_bitmap = dart->pgsize,
  493. .ias = dart->ias,
  494. .oas = dart->oas,
  495. .coherent_walk = 1,
  496. .iommu_dev = dart->dev,
  497. };
  498. dart_domain->pgtbl_ops = alloc_io_pgtable_ops(dart->hw->fmt, &pgtbl_cfg,
  499. &dart_domain->domain);
  500. if (!dart_domain->pgtbl_ops) {
  501. ret = -ENOMEM;
  502. goto done;
  503. }
  504. dart_domain->domain.pgsize_bitmap = pgtbl_cfg.pgsize_bitmap;
  505. dart_domain->domain.geometry.aperture_start = 0;
  506. dart_domain->domain.geometry.aperture_end =
  507. (dma_addr_t)DMA_BIT_MASK(pgtbl_cfg.ias);
  508. dart_domain->domain.geometry.force_aperture = true;
  509. dart_domain->finalized = true;
  510. done:
  511. mutex_unlock(&dart_domain->init_lock);
  512. return ret;
  513. }
  514. static int
  515. apple_dart_mod_streams(struct apple_dart_atomic_stream_map *domain_maps,
  516. struct apple_dart_stream_map *master_maps,
  517. bool add_streams)
  518. {
  519. int i, j;
  520. for (i = 0; i < MAX_DARTS_PER_DEVICE; ++i) {
  521. if (domain_maps[i].dart != master_maps[i].dart)
  522. return -EINVAL;
  523. }
  524. for (i = 0; i < MAX_DARTS_PER_DEVICE; ++i) {
  525. if (!domain_maps[i].dart)
  526. break;
  527. for (j = 0; j < BITS_TO_LONGS(domain_maps[i].dart->num_streams); j++) {
  528. if (add_streams)
  529. atomic_long_or(master_maps[i].sidmap[j],
  530. &domain_maps[i].sidmap[j]);
  531. else
  532. atomic_long_and(~master_maps[i].sidmap[j],
  533. &domain_maps[i].sidmap[j]);
  534. }
  535. }
  536. return 0;
  537. }
  538. static int apple_dart_domain_add_streams(struct apple_dart_domain *domain,
  539. struct apple_dart_master_cfg *cfg)
  540. {
  541. return apple_dart_mod_streams(domain->stream_maps, cfg->stream_maps,
  542. true);
  543. }
  544. static int apple_dart_attach_dev_paging(struct iommu_domain *domain,
  545. struct device *dev,
  546. struct iommu_domain *old)
  547. {
  548. int ret, i;
  549. struct apple_dart_stream_map *stream_map;
  550. struct apple_dart_master_cfg *cfg = dev_iommu_priv_get(dev);
  551. struct apple_dart_domain *dart_domain = to_dart_domain(domain);
  552. ret = apple_dart_finalize_domain(dart_domain, cfg);
  553. if (ret)
  554. return ret;
  555. ret = apple_dart_domain_add_streams(dart_domain, cfg);
  556. if (ret)
  557. return ret;
  558. for_each_stream_map(i, cfg, stream_map)
  559. apple_dart_setup_translation(dart_domain, stream_map);
  560. return 0;
  561. }
  562. static int apple_dart_attach_dev_identity(struct iommu_domain *domain,
  563. struct device *dev,
  564. struct iommu_domain *old)
  565. {
  566. struct apple_dart_master_cfg *cfg = dev_iommu_priv_get(dev);
  567. struct apple_dart_stream_map *stream_map;
  568. int i;
  569. if (!cfg->supports_bypass)
  570. return -EINVAL;
  571. for_each_stream_map(i, cfg, stream_map)
  572. apple_dart_hw_enable_bypass(stream_map);
  573. return 0;
  574. }
  575. static const struct iommu_domain_ops apple_dart_identity_ops = {
  576. .attach_dev = apple_dart_attach_dev_identity,
  577. };
  578. static struct iommu_domain apple_dart_identity_domain = {
  579. .type = IOMMU_DOMAIN_IDENTITY,
  580. .ops = &apple_dart_identity_ops,
  581. };
  582. static int apple_dart_attach_dev_blocked(struct iommu_domain *domain,
  583. struct device *dev,
  584. struct iommu_domain *old)
  585. {
  586. struct apple_dart_master_cfg *cfg = dev_iommu_priv_get(dev);
  587. struct apple_dart_stream_map *stream_map;
  588. int i;
  589. for_each_stream_map(i, cfg, stream_map)
  590. apple_dart_hw_disable_dma(stream_map);
  591. return 0;
  592. }
  593. static const struct iommu_domain_ops apple_dart_blocked_ops = {
  594. .attach_dev = apple_dart_attach_dev_blocked,
  595. };
  596. static struct iommu_domain apple_dart_blocked_domain = {
  597. .type = IOMMU_DOMAIN_BLOCKED,
  598. .ops = &apple_dart_blocked_ops,
  599. };
  600. static struct iommu_device *apple_dart_probe_device(struct device *dev)
  601. {
  602. struct apple_dart_master_cfg *cfg = dev_iommu_priv_get(dev);
  603. struct apple_dart_stream_map *stream_map;
  604. int i;
  605. if (!cfg)
  606. return ERR_PTR(-ENODEV);
  607. for_each_stream_map(i, cfg, stream_map)
  608. device_link_add(
  609. dev, stream_map->dart->dev,
  610. DL_FLAG_PM_RUNTIME | DL_FLAG_AUTOREMOVE_SUPPLIER);
  611. return &cfg->stream_maps[0].dart->iommu;
  612. }
  613. static void apple_dart_release_device(struct device *dev)
  614. {
  615. struct apple_dart_master_cfg *cfg = dev_iommu_priv_get(dev);
  616. kfree(cfg);
  617. }
  618. static struct iommu_domain *apple_dart_domain_alloc_paging(struct device *dev)
  619. {
  620. struct apple_dart_domain *dart_domain;
  621. dart_domain = kzalloc_obj(*dart_domain);
  622. if (!dart_domain)
  623. return NULL;
  624. mutex_init(&dart_domain->init_lock);
  625. if (dev) {
  626. struct apple_dart_master_cfg *cfg = dev_iommu_priv_get(dev);
  627. int ret;
  628. ret = apple_dart_finalize_domain(dart_domain, cfg);
  629. if (ret) {
  630. kfree(dart_domain);
  631. return ERR_PTR(ret);
  632. }
  633. }
  634. return &dart_domain->domain;
  635. }
  636. static void apple_dart_domain_free(struct iommu_domain *domain)
  637. {
  638. struct apple_dart_domain *dart_domain = to_dart_domain(domain);
  639. free_io_pgtable_ops(dart_domain->pgtbl_ops);
  640. kfree(dart_domain);
  641. }
  642. static int apple_dart_of_xlate(struct device *dev,
  643. const struct of_phandle_args *args)
  644. {
  645. struct apple_dart_master_cfg *cfg = dev_iommu_priv_get(dev);
  646. struct platform_device *iommu_pdev = of_find_device_by_node(args->np);
  647. struct apple_dart *dart = platform_get_drvdata(iommu_pdev);
  648. struct apple_dart *cfg_dart;
  649. int i, sid;
  650. put_device(&iommu_pdev->dev);
  651. if (args->args_count != 1)
  652. return -EINVAL;
  653. sid = args->args[0];
  654. if (!cfg) {
  655. cfg = kzalloc_obj(*cfg);
  656. if (!cfg)
  657. return -ENOMEM;
  658. /* Will be ANDed with DART capabilities */
  659. cfg->supports_bypass = true;
  660. }
  661. dev_iommu_priv_set(dev, cfg);
  662. cfg_dart = cfg->stream_maps[0].dart;
  663. if (cfg_dart) {
  664. if (cfg_dart->pgsize != dart->pgsize)
  665. return -EINVAL;
  666. if (cfg_dart->ias != dart->ias)
  667. return -EINVAL;
  668. }
  669. cfg->supports_bypass &= dart->supports_bypass;
  670. for (i = 0; i < MAX_DARTS_PER_DEVICE; ++i) {
  671. if (cfg->stream_maps[i].dart == dart) {
  672. set_bit(sid, cfg->stream_maps[i].sidmap);
  673. return 0;
  674. }
  675. }
  676. for (i = 0; i < MAX_DARTS_PER_DEVICE; ++i) {
  677. if (!cfg->stream_maps[i].dart) {
  678. cfg->stream_maps[i].dart = dart;
  679. set_bit(sid, cfg->stream_maps[i].sidmap);
  680. return 0;
  681. }
  682. }
  683. return -EINVAL;
  684. }
  685. static DEFINE_MUTEX(apple_dart_groups_lock);
  686. static void apple_dart_release_group(void *iommu_data)
  687. {
  688. int i, sid;
  689. struct apple_dart_stream_map *stream_map;
  690. struct apple_dart_master_cfg *group_master_cfg = iommu_data;
  691. mutex_lock(&apple_dart_groups_lock);
  692. for_each_stream_map(i, group_master_cfg, stream_map)
  693. for_each_set_bit(sid, stream_map->sidmap, stream_map->dart->num_streams)
  694. stream_map->dart->sid2group[sid] = NULL;
  695. kfree(iommu_data);
  696. mutex_unlock(&apple_dart_groups_lock);
  697. }
  698. static int apple_dart_merge_master_cfg(struct apple_dart_master_cfg *dst,
  699. struct apple_dart_master_cfg *src)
  700. {
  701. /*
  702. * We know that this function is only called for groups returned from
  703. * pci_device_group and that all Apple Silicon platforms never spread
  704. * PCIe devices from the same bus across multiple DARTs such that we can
  705. * just assume that both src and dst only have the same single DART.
  706. */
  707. if (src->stream_maps[1].dart)
  708. return -EINVAL;
  709. if (dst->stream_maps[1].dart)
  710. return -EINVAL;
  711. if (src->stream_maps[0].dart != dst->stream_maps[0].dart)
  712. return -EINVAL;
  713. bitmap_or(dst->stream_maps[0].sidmap,
  714. dst->stream_maps[0].sidmap,
  715. src->stream_maps[0].sidmap,
  716. dst->stream_maps[0].dart->num_streams);
  717. return 0;
  718. }
  719. static struct iommu_group *apple_dart_device_group(struct device *dev)
  720. {
  721. int i, sid;
  722. struct apple_dart_master_cfg *cfg = dev_iommu_priv_get(dev);
  723. struct apple_dart_stream_map *stream_map;
  724. struct apple_dart_master_cfg *group_master_cfg;
  725. struct iommu_group *group = NULL;
  726. struct iommu_group *res = ERR_PTR(-EINVAL);
  727. mutex_lock(&apple_dart_groups_lock);
  728. for_each_stream_map(i, cfg, stream_map) {
  729. for_each_set_bit(sid, stream_map->sidmap, stream_map->dart->num_streams) {
  730. struct iommu_group *stream_group =
  731. stream_map->dart->sid2group[sid];
  732. if (group && group != stream_group) {
  733. res = ERR_PTR(-EINVAL);
  734. goto out;
  735. }
  736. group = stream_group;
  737. }
  738. }
  739. if (group) {
  740. res = iommu_group_ref_get(group);
  741. goto out;
  742. }
  743. #ifdef CONFIG_PCI
  744. if (dev_is_pci(dev))
  745. group = pci_device_group(dev);
  746. else
  747. #endif
  748. group = generic_device_group(dev);
  749. res = ERR_PTR(-ENOMEM);
  750. if (!group)
  751. goto out;
  752. group_master_cfg = iommu_group_get_iommudata(group);
  753. if (group_master_cfg) {
  754. int ret;
  755. ret = apple_dart_merge_master_cfg(group_master_cfg, cfg);
  756. if (ret) {
  757. dev_err(dev, "Failed to merge DART IOMMU groups.\n");
  758. iommu_group_put(group);
  759. res = ERR_PTR(ret);
  760. goto out;
  761. }
  762. } else {
  763. group_master_cfg = kmemdup(cfg, sizeof(*group_master_cfg),
  764. GFP_KERNEL);
  765. if (!group_master_cfg) {
  766. iommu_group_put(group);
  767. goto out;
  768. }
  769. iommu_group_set_iommudata(group, group_master_cfg,
  770. apple_dart_release_group);
  771. }
  772. for_each_stream_map(i, cfg, stream_map)
  773. for_each_set_bit(sid, stream_map->sidmap, stream_map->dart->num_streams)
  774. stream_map->dart->sid2group[sid] = group;
  775. res = group;
  776. out:
  777. mutex_unlock(&apple_dart_groups_lock);
  778. return res;
  779. }
  780. static int apple_dart_def_domain_type(struct device *dev)
  781. {
  782. struct apple_dart_master_cfg *cfg = dev_iommu_priv_get(dev);
  783. if (cfg->stream_maps[0].dart->pgsize > PAGE_SIZE)
  784. return IOMMU_DOMAIN_IDENTITY;
  785. if (!cfg->supports_bypass)
  786. return IOMMU_DOMAIN_DMA;
  787. return 0;
  788. }
  789. #ifndef CONFIG_PCIE_APPLE_MSI_DOORBELL_ADDR
  790. /* Keep things compiling when CONFIG_PCI_APPLE isn't selected */
  791. #define CONFIG_PCIE_APPLE_MSI_DOORBELL_ADDR 0
  792. #endif
  793. #define DOORBELL_ADDR (CONFIG_PCIE_APPLE_MSI_DOORBELL_ADDR & PAGE_MASK)
  794. static void apple_dart_get_resv_regions(struct device *dev,
  795. struct list_head *head)
  796. {
  797. if (IS_ENABLED(CONFIG_PCIE_APPLE) && dev_is_pci(dev)) {
  798. struct iommu_resv_region *region;
  799. int prot = IOMMU_WRITE | IOMMU_NOEXEC | IOMMU_MMIO;
  800. region = iommu_alloc_resv_region(DOORBELL_ADDR,
  801. PAGE_SIZE, prot,
  802. IOMMU_RESV_MSI, GFP_KERNEL);
  803. if (!region)
  804. return;
  805. list_add_tail(&region->list, head);
  806. }
  807. iommu_dma_get_resv_regions(dev, head);
  808. }
  809. static const struct iommu_ops apple_dart_iommu_ops = {
  810. .identity_domain = &apple_dart_identity_domain,
  811. .blocked_domain = &apple_dart_blocked_domain,
  812. .domain_alloc_paging = apple_dart_domain_alloc_paging,
  813. .probe_device = apple_dart_probe_device,
  814. .release_device = apple_dart_release_device,
  815. .device_group = apple_dart_device_group,
  816. .of_xlate = apple_dart_of_xlate,
  817. .def_domain_type = apple_dart_def_domain_type,
  818. .get_resv_regions = apple_dart_get_resv_regions,
  819. .owner = THIS_MODULE,
  820. .default_domain_ops = &(const struct iommu_domain_ops) {
  821. .attach_dev = apple_dart_attach_dev_paging,
  822. .map_pages = apple_dart_map_pages,
  823. .unmap_pages = apple_dart_unmap_pages,
  824. .flush_iotlb_all = apple_dart_flush_iotlb_all,
  825. .iotlb_sync = apple_dart_iotlb_sync,
  826. .iotlb_sync_map = apple_dart_iotlb_sync_map,
  827. .iova_to_phys = apple_dart_iova_to_phys,
  828. .free = apple_dart_domain_free,
  829. }
  830. };
  831. static irqreturn_t apple_dart_t8020_irq(int irq, void *dev)
  832. {
  833. struct apple_dart *dart = dev;
  834. const char *fault_name = NULL;
  835. u32 error = readl(dart->regs + DART_T8020_ERROR);
  836. u32 error_code = FIELD_GET(DART_T8020_ERROR_CODE, error);
  837. u32 addr_lo = readl(dart->regs + DART_T8020_ERROR_ADDR_LO);
  838. u32 addr_hi = readl(dart->regs + DART_T8020_ERROR_ADDR_HI);
  839. u64 addr = addr_lo | (((u64)addr_hi) << 32);
  840. u8 stream_idx = FIELD_GET(DART_T8020_ERROR_STREAM, error);
  841. if (!(error & DART_T8020_ERROR_FLAG))
  842. return IRQ_NONE;
  843. /* there should only be a single bit set but let's use == to be sure */
  844. if (error_code == DART_T8020_ERROR_READ_FAULT)
  845. fault_name = "READ FAULT";
  846. else if (error_code == DART_T8020_ERROR_WRITE_FAULT)
  847. fault_name = "WRITE FAULT";
  848. else if (error_code == DART_T8020_ERROR_NO_PTE)
  849. fault_name = "NO PTE FOR IOVA";
  850. else if (error_code == DART_T8020_ERROR_NO_PMD)
  851. fault_name = "NO PMD FOR IOVA";
  852. else if (error_code == DART_T8020_ERROR_NO_TTBR)
  853. fault_name = "NO TTBR FOR IOVA";
  854. else
  855. fault_name = "unknown";
  856. dev_err_ratelimited(
  857. dart->dev,
  858. "translation fault: status:0x%x stream:%d code:0x%x (%s) at 0x%llx",
  859. error, stream_idx, error_code, fault_name, addr);
  860. writel(error, dart->regs + DART_T8020_ERROR);
  861. return IRQ_HANDLED;
  862. }
  863. static irqreturn_t apple_dart_t8110_irq(int irq, void *dev)
  864. {
  865. struct apple_dart *dart = dev;
  866. const char *fault_name = NULL;
  867. u32 error = readl(dart->regs + DART_T8110_ERROR);
  868. u32 error_code = FIELD_GET(DART_T8110_ERROR_CODE, error);
  869. u32 addr_lo = readl(dart->regs + DART_T8110_ERROR_ADDR_LO);
  870. u32 addr_hi = readl(dart->regs + DART_T8110_ERROR_ADDR_HI);
  871. u64 addr = addr_lo | (((u64)addr_hi) << 32);
  872. u8 stream_idx = FIELD_GET(DART_T8110_ERROR_STREAM, error);
  873. if (!(error & DART_T8110_ERROR_FLAG))
  874. return IRQ_NONE;
  875. /* there should only be a single bit set but let's use == to be sure */
  876. if (error_code == DART_T8110_ERROR_READ_FAULT)
  877. fault_name = "READ FAULT";
  878. else if (error_code == DART_T8110_ERROR_WRITE_FAULT)
  879. fault_name = "WRITE FAULT";
  880. else if (error_code == DART_T8110_ERROR_NO_PTE)
  881. fault_name = "NO PTE FOR IOVA";
  882. else if (error_code == DART_T8110_ERROR_NO_PMD)
  883. fault_name = "NO PMD FOR IOVA";
  884. else if (error_code == DART_T8110_ERROR_NO_PGD)
  885. fault_name = "NO PGD FOR IOVA";
  886. else if (error_code == DART_T8110_ERROR_NO_TTBR)
  887. fault_name = "NO TTBR FOR IOVA";
  888. else
  889. fault_name = "unknown";
  890. dev_err_ratelimited(
  891. dart->dev,
  892. "translation fault: status:0x%x stream:%d code:0x%x (%s) at 0x%llx",
  893. error, stream_idx, error_code, fault_name, addr);
  894. writel(error, dart->regs + DART_T8110_ERROR);
  895. for (int i = 0; i < BITS_TO_U32(dart->num_streams); i++)
  896. writel(U32_MAX, dart->regs + DART_T8110_ERROR_STREAMS + 4 * i);
  897. return IRQ_HANDLED;
  898. }
  899. static int apple_dart_probe(struct platform_device *pdev)
  900. {
  901. int ret;
  902. u32 dart_params[4];
  903. struct resource *res;
  904. struct apple_dart *dart;
  905. struct device *dev = &pdev->dev;
  906. dart = devm_kzalloc(dev, sizeof(*dart), GFP_KERNEL);
  907. if (!dart)
  908. return -ENOMEM;
  909. dart->dev = dev;
  910. dart->hw = of_device_get_match_data(dev);
  911. spin_lock_init(&dart->lock);
  912. dart->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
  913. if (IS_ERR(dart->regs))
  914. return PTR_ERR(dart->regs);
  915. if (resource_size(res) < 0x4000) {
  916. dev_err(dev, "MMIO region too small (%pr)\n", res);
  917. return -EINVAL;
  918. }
  919. dart->irq = platform_get_irq(pdev, 0);
  920. if (dart->irq < 0)
  921. return -ENODEV;
  922. ret = devm_clk_bulk_get_all(dev, &dart->clks);
  923. if (ret < 0)
  924. return ret;
  925. dart->num_clks = ret;
  926. ret = clk_bulk_prepare_enable(dart->num_clks, dart->clks);
  927. if (ret)
  928. return ret;
  929. dart_params[0] = readl(dart->regs + DART_PARAMS1);
  930. dart_params[1] = readl(dart->regs + DART_PARAMS2);
  931. dart->pgsize = 1 << FIELD_GET(DART_PARAMS1_PAGE_SHIFT, dart_params[0]);
  932. dart->supports_bypass = dart_params[1] & DART_PARAMS2_BYPASS_SUPPORT;
  933. switch (dart->hw->type) {
  934. case DART_T8020:
  935. case DART_T6000:
  936. dart->ias = 32;
  937. dart->oas = dart->hw->oas;
  938. dart->num_streams = dart->hw->max_sid_count;
  939. break;
  940. case DART_T8110:
  941. dart_params[2] = readl(dart->regs + DART_T8110_PARAMS3);
  942. dart_params[3] = readl(dart->regs + DART_T8110_PARAMS4);
  943. dart->ias = FIELD_GET(DART_T8110_PARAMS3_VA_WIDTH, dart_params[2]);
  944. dart->oas = FIELD_GET(DART_T8110_PARAMS3_PA_WIDTH, dart_params[2]);
  945. dart->num_streams = FIELD_GET(DART_T8110_PARAMS4_NUM_SIDS, dart_params[3]);
  946. dart->four_level = dart->ias > 36;
  947. break;
  948. }
  949. if (dart->num_streams > DART_MAX_STREAMS) {
  950. dev_err(&pdev->dev, "Too many streams (%d > %d)\n",
  951. dart->num_streams, DART_MAX_STREAMS);
  952. ret = -EINVAL;
  953. goto err_clk_disable;
  954. }
  955. ret = apple_dart_hw_reset(dart);
  956. if (ret)
  957. goto err_clk_disable;
  958. ret = request_irq(dart->irq, dart->hw->irq_handler, IRQF_SHARED,
  959. "apple-dart fault handler", dart);
  960. if (ret)
  961. goto err_clk_disable;
  962. platform_set_drvdata(pdev, dart);
  963. ret = iommu_device_sysfs_add(&dart->iommu, dev, NULL, "apple-dart.%s",
  964. dev_name(&pdev->dev));
  965. if (ret)
  966. goto err_free_irq;
  967. ret = iommu_device_register(&dart->iommu, &apple_dart_iommu_ops, dev);
  968. if (ret)
  969. goto err_sysfs_remove;
  970. dev_info(
  971. &pdev->dev,
  972. "DART [pagesize %x, %d streams, bypass support: %d, bypass forced: %d, AS %d -> %d] initialized\n",
  973. dart->pgsize, dart->num_streams, dart->supports_bypass,
  974. dart->pgsize > PAGE_SIZE, dart->ias, dart->oas);
  975. return 0;
  976. err_sysfs_remove:
  977. iommu_device_sysfs_remove(&dart->iommu);
  978. err_free_irq:
  979. free_irq(dart->irq, dart);
  980. err_clk_disable:
  981. clk_bulk_disable_unprepare(dart->num_clks, dart->clks);
  982. return ret;
  983. }
  984. static void apple_dart_remove(struct platform_device *pdev)
  985. {
  986. struct apple_dart *dart = platform_get_drvdata(pdev);
  987. apple_dart_hw_reset(dart);
  988. free_irq(dart->irq, dart);
  989. iommu_device_unregister(&dart->iommu);
  990. iommu_device_sysfs_remove(&dart->iommu);
  991. clk_bulk_disable_unprepare(dart->num_clks, dart->clks);
  992. }
  993. static const struct apple_dart_hw apple_dart_hw_t8103 = {
  994. .type = DART_T8020,
  995. .irq_handler = apple_dart_t8020_irq,
  996. .invalidate_tlb = apple_dart_t8020_hw_invalidate_tlb,
  997. .oas = 36,
  998. .fmt = APPLE_DART,
  999. .max_sid_count = 16,
  1000. .enable_streams = DART_T8020_STREAMS_ENABLE,
  1001. .lock = DART_T8020_CONFIG,
  1002. .lock_bit = DART_T8020_CONFIG_LOCK,
  1003. .error = DART_T8020_ERROR,
  1004. .tcr = DART_T8020_TCR,
  1005. .tcr_enabled = DART_T8020_TCR_TRANSLATE_ENABLE,
  1006. .tcr_disabled = 0,
  1007. .tcr_bypass = DART_T8020_TCR_BYPASS_DAPF | DART_T8020_TCR_BYPASS_DART,
  1008. .ttbr = DART_T8020_TTBR,
  1009. .ttbr_valid = DART_T8020_TTBR_VALID,
  1010. .ttbr_addr_field_shift = DART_T8020_TTBR_ADDR_FIELD_SHIFT,
  1011. .ttbr_shift = DART_T8020_TTBR_SHIFT,
  1012. .ttbr_count = 4,
  1013. };
  1014. static const struct apple_dart_hw apple_dart_hw_t8103_usb4 = {
  1015. .type = DART_T8020,
  1016. .irq_handler = apple_dart_t8020_irq,
  1017. .invalidate_tlb = apple_dart_t8020_hw_invalidate_tlb,
  1018. .oas = 36,
  1019. .fmt = APPLE_DART,
  1020. .max_sid_count = 64,
  1021. .enable_streams = DART_T8020_STREAMS_ENABLE,
  1022. .lock = DART_T8020_CONFIG,
  1023. .lock_bit = DART_T8020_CONFIG_LOCK,
  1024. .error = DART_T8020_ERROR,
  1025. .tcr = DART_T8020_TCR,
  1026. .tcr_enabled = DART_T8020_TCR_TRANSLATE_ENABLE,
  1027. .tcr_disabled = 0,
  1028. .tcr_bypass = 0,
  1029. .ttbr = DART_T8020_USB4_TTBR,
  1030. .ttbr_valid = DART_T8020_TTBR_VALID,
  1031. .ttbr_addr_field_shift = DART_T8020_TTBR_ADDR_FIELD_SHIFT,
  1032. .ttbr_shift = DART_T8020_TTBR_SHIFT,
  1033. .ttbr_count = 4,
  1034. };
  1035. static const struct apple_dart_hw apple_dart_hw_t6000 = {
  1036. .type = DART_T6000,
  1037. .irq_handler = apple_dart_t8020_irq,
  1038. .invalidate_tlb = apple_dart_t8020_hw_invalidate_tlb,
  1039. .oas = 42,
  1040. .fmt = APPLE_DART2,
  1041. .max_sid_count = 16,
  1042. .enable_streams = DART_T8020_STREAMS_ENABLE,
  1043. .lock = DART_T8020_CONFIG,
  1044. .lock_bit = DART_T8020_CONFIG_LOCK,
  1045. .error = DART_T8020_ERROR,
  1046. .tcr = DART_T8020_TCR,
  1047. .tcr_enabled = DART_T8020_TCR_TRANSLATE_ENABLE,
  1048. .tcr_disabled = 0,
  1049. .tcr_bypass = DART_T8020_TCR_BYPASS_DAPF | DART_T8020_TCR_BYPASS_DART,
  1050. .ttbr = DART_T8020_TTBR,
  1051. .ttbr_valid = DART_T8020_TTBR_VALID,
  1052. .ttbr_addr_field_shift = DART_T8020_TTBR_ADDR_FIELD_SHIFT,
  1053. .ttbr_shift = DART_T8020_TTBR_SHIFT,
  1054. .ttbr_count = 4,
  1055. };
  1056. static const struct apple_dart_hw apple_dart_hw_t8110 = {
  1057. .type = DART_T8110,
  1058. .irq_handler = apple_dart_t8110_irq,
  1059. .invalidate_tlb = apple_dart_t8110_hw_invalidate_tlb,
  1060. .fmt = APPLE_DART2,
  1061. .max_sid_count = 256,
  1062. .enable_streams = DART_T8110_ENABLE_STREAMS,
  1063. .lock = DART_T8110_PROTECT,
  1064. .lock_bit = DART_T8110_PROTECT_TTBR_TCR,
  1065. .error = DART_T8110_ERROR,
  1066. .tcr = DART_T8110_TCR,
  1067. .tcr_enabled = DART_T8110_TCR_TRANSLATE_ENABLE,
  1068. .tcr_disabled = 0,
  1069. .tcr_bypass = DART_T8110_TCR_BYPASS_DAPF | DART_T8110_TCR_BYPASS_DART,
  1070. .tcr_4level = DART_T8110_TCR_FOUR_LEVEL,
  1071. .ttbr = DART_T8110_TTBR,
  1072. .ttbr_valid = DART_T8110_TTBR_VALID,
  1073. .ttbr_addr_field_shift = DART_T8110_TTBR_ADDR_FIELD_SHIFT,
  1074. .ttbr_shift = DART_T8110_TTBR_SHIFT,
  1075. .ttbr_count = 1,
  1076. };
  1077. static __maybe_unused int apple_dart_suspend(struct device *dev)
  1078. {
  1079. struct apple_dart *dart = dev_get_drvdata(dev);
  1080. unsigned int sid, idx;
  1081. for (sid = 0; sid < dart->num_streams; sid++) {
  1082. dart->save_tcr[sid] = readl(dart->regs + DART_TCR(dart, sid));
  1083. for (idx = 0; idx < dart->hw->ttbr_count; idx++)
  1084. dart->save_ttbr[sid][idx] =
  1085. readl(dart->regs + DART_TTBR(dart, sid, idx));
  1086. }
  1087. return 0;
  1088. }
  1089. static __maybe_unused int apple_dart_resume(struct device *dev)
  1090. {
  1091. struct apple_dart *dart = dev_get_drvdata(dev);
  1092. unsigned int sid, idx;
  1093. int ret;
  1094. ret = apple_dart_hw_reset(dart);
  1095. if (ret) {
  1096. dev_err(dev, "Failed to reset DART on resume\n");
  1097. return ret;
  1098. }
  1099. for (sid = 0; sid < dart->num_streams; sid++) {
  1100. for (idx = 0; idx < dart->hw->ttbr_count; idx++)
  1101. writel(dart->save_ttbr[sid][idx],
  1102. dart->regs + DART_TTBR(dart, sid, idx));
  1103. writel(dart->save_tcr[sid], dart->regs + DART_TCR(dart, sid));
  1104. }
  1105. return 0;
  1106. }
  1107. static DEFINE_SIMPLE_DEV_PM_OPS(apple_dart_pm_ops, apple_dart_suspend, apple_dart_resume);
  1108. static const struct of_device_id apple_dart_of_match[] = {
  1109. { .compatible = "apple,t8103-dart", .data = &apple_dart_hw_t8103 },
  1110. { .compatible = "apple,t8103-usb4-dart", .data = &apple_dart_hw_t8103_usb4 },
  1111. { .compatible = "apple,t8110-dart", .data = &apple_dart_hw_t8110 },
  1112. { .compatible = "apple,t6000-dart", .data = &apple_dart_hw_t6000 },
  1113. {},
  1114. };
  1115. MODULE_DEVICE_TABLE(of, apple_dart_of_match);
  1116. static struct platform_driver apple_dart_driver = {
  1117. .driver = {
  1118. .name = "apple-dart",
  1119. .of_match_table = apple_dart_of_match,
  1120. .suppress_bind_attrs = true,
  1121. .pm = pm_sleep_ptr(&apple_dart_pm_ops),
  1122. },
  1123. .probe = apple_dart_probe,
  1124. .remove = apple_dart_remove,
  1125. };
  1126. module_platform_driver(apple_dart_driver);
  1127. MODULE_DESCRIPTION("IOMMU API for Apple's DART");
  1128. MODULE_AUTHOR("Sven Peter <sven@svenpeter.dev>");
  1129. MODULE_LICENSE("GPL v2");