spi-uclass.c 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Copyright (c) 2014 Google, Inc
  4. */
  5. #include <common.h>
  6. #include <dm.h>
  7. #include <errno.h>
  8. #include <malloc.h>
  9. #include <spi.h>
  10. #include <dm/device-internal.h>
  11. #include <dm/uclass-internal.h>
  12. #include <dm/lists.h>
  13. #include <dm/util.h>
  14. DECLARE_GLOBAL_DATA_PTR;
  15. static int spi_set_speed_mode(struct udevice *bus, int speed, int mode)
  16. {
  17. struct dm_spi_ops *ops;
  18. int ret;
  19. ops = spi_get_ops(bus);
  20. if (ops->set_speed)
  21. ret = ops->set_speed(bus, speed);
  22. else
  23. ret = -EINVAL;
  24. if (ret) {
  25. printf("Cannot set speed (err=%d)\n", ret);
  26. return ret;
  27. }
  28. if (ops->set_mode)
  29. ret = ops->set_mode(bus, mode);
  30. else
  31. ret = -EINVAL;
  32. if (ret) {
  33. printf("Cannot set mode (err=%d)\n", ret);
  34. return ret;
  35. }
  36. return 0;
  37. }
  38. int dm_spi_claim_bus(struct udevice *dev)
  39. {
  40. struct udevice *bus = dev->parent;
  41. struct dm_spi_ops *ops = spi_get_ops(bus);
  42. struct dm_spi_bus *spi = dev_get_uclass_priv(bus);
  43. struct spi_slave *slave = dev_get_parent_priv(dev);
  44. int speed;
  45. speed = slave->max_hz;
  46. if (spi->max_hz) {
  47. if (speed)
  48. speed = min(speed, (int)spi->max_hz);
  49. else
  50. speed = spi->max_hz;
  51. }
  52. if (!speed)
  53. speed = 100000;
  54. if (speed != slave->speed) {
  55. int ret = spi_set_speed_mode(bus, speed, slave->mode);
  56. if (ret)
  57. return ret;
  58. slave->speed = speed;
  59. }
  60. return ops->claim_bus ? ops->claim_bus(dev) : 0;
  61. }
  62. void dm_spi_release_bus(struct udevice *dev)
  63. {
  64. struct udevice *bus = dev->parent;
  65. struct dm_spi_ops *ops = spi_get_ops(bus);
  66. if (ops->release_bus)
  67. ops->release_bus(dev);
  68. }
  69. int dm_spi_xfer(struct udevice *dev, unsigned int bitlen,
  70. const void *dout, void *din, unsigned long flags)
  71. {
  72. struct udevice *bus = dev->parent;
  73. if (bus->uclass->uc_drv->id != UCLASS_SPI)
  74. return -EOPNOTSUPP;
  75. return spi_get_ops(bus)->xfer(dev, bitlen, dout, din, flags);
  76. }
  77. int spi_claim_bus(struct spi_slave *slave)
  78. {
  79. return dm_spi_claim_bus(slave->dev);
  80. }
  81. void spi_release_bus(struct spi_slave *slave)
  82. {
  83. dm_spi_release_bus(slave->dev);
  84. }
  85. int spi_xfer(struct spi_slave *slave, unsigned int bitlen,
  86. const void *dout, void *din, unsigned long flags)
  87. {
  88. return dm_spi_xfer(slave->dev, bitlen, dout, din, flags);
  89. }
  90. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  91. static int spi_child_post_bind(struct udevice *dev)
  92. {
  93. struct dm_spi_slave_platdata *plat = dev_get_parent_platdata(dev);
  94. if (!dev_of_valid(dev))
  95. return 0;
  96. return spi_slave_ofdata_to_platdata(dev, plat);
  97. }
  98. #endif
  99. static int spi_post_probe(struct udevice *bus)
  100. {
  101. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  102. struct dm_spi_bus *spi = dev_get_uclass_priv(bus);
  103. spi->max_hz = dev_read_u32_default(bus, "spi-max-frequency", 0);
  104. #endif
  105. #if defined(CONFIG_NEEDS_MANUAL_RELOC)
  106. struct dm_spi_ops *ops = spi_get_ops(bus);
  107. if (ops->claim_bus)
  108. ops->claim_bus += gd->reloc_off;
  109. if (ops->release_bus)
  110. ops->release_bus += gd->reloc_off;
  111. if (ops->set_wordlen)
  112. ops->set_wordlen += gd->reloc_off;
  113. if (ops->xfer)
  114. ops->xfer += gd->reloc_off;
  115. if (ops->set_speed)
  116. ops->set_speed += gd->reloc_off;
  117. if (ops->set_mode)
  118. ops->set_mode += gd->reloc_off;
  119. if (ops->cs_info)
  120. ops->cs_info += gd->reloc_off;
  121. #endif
  122. return 0;
  123. }
  124. static int spi_child_pre_probe(struct udevice *dev)
  125. {
  126. struct dm_spi_slave_platdata *plat = dev_get_parent_platdata(dev);
  127. struct spi_slave *slave = dev_get_parent_priv(dev);
  128. /*
  129. * This is needed because we pass struct spi_slave around the place
  130. * instead slave->dev (a struct udevice). So we have to have some
  131. * way to access the slave udevice given struct spi_slave. Once we
  132. * change the SPI API to use udevice instead of spi_slave, we can
  133. * drop this.
  134. */
  135. slave->dev = dev;
  136. slave->max_hz = plat->max_hz;
  137. slave->mode = plat->mode;
  138. slave->wordlen = SPI_DEFAULT_WORDLEN;
  139. return 0;
  140. }
  141. int spi_chip_select(struct udevice *dev)
  142. {
  143. struct dm_spi_slave_platdata *plat = dev_get_parent_platdata(dev);
  144. return plat ? plat->cs : -ENOENT;
  145. }
  146. int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp)
  147. {
  148. struct udevice *dev;
  149. for (device_find_first_child(bus, &dev); dev;
  150. device_find_next_child(&dev)) {
  151. struct dm_spi_slave_platdata *plat;
  152. plat = dev_get_parent_platdata(dev);
  153. debug("%s: plat=%p, cs=%d\n", __func__, plat, plat->cs);
  154. if (plat->cs == cs) {
  155. *devp = dev;
  156. return 0;
  157. }
  158. }
  159. return -ENODEV;
  160. }
  161. int spi_cs_is_valid(unsigned int busnum, unsigned int cs)
  162. {
  163. struct spi_cs_info info;
  164. struct udevice *bus;
  165. int ret;
  166. ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, false, &bus);
  167. if (ret) {
  168. debug("%s: No bus %d\n", __func__, busnum);
  169. return ret;
  170. }
  171. return spi_cs_info(bus, cs, &info);
  172. }
  173. int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info)
  174. {
  175. struct spi_cs_info local_info;
  176. struct dm_spi_ops *ops;
  177. int ret;
  178. if (!info)
  179. info = &local_info;
  180. /* If there is a device attached, return it */
  181. info->dev = NULL;
  182. ret = spi_find_chip_select(bus, cs, &info->dev);
  183. if (!ret)
  184. return 0;
  185. /*
  186. * Otherwise ask the driver. For the moment we don't have CS info.
  187. * When we do we could provide the driver with a helper function
  188. * to figure out what chip selects are valid, or just handle the
  189. * request.
  190. */
  191. ops = spi_get_ops(bus);
  192. if (ops->cs_info)
  193. return ops->cs_info(bus, cs, info);
  194. /*
  195. * We could assume there is at least one valid chip select, but best
  196. * to be sure and return an error in this case. The driver didn't
  197. * care enough to tell us.
  198. */
  199. return -ENODEV;
  200. }
  201. int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp,
  202. struct udevice **devp)
  203. {
  204. struct udevice *bus, *dev;
  205. int ret;
  206. ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, false, &bus);
  207. if (ret) {
  208. debug("%s: No bus %d\n", __func__, busnum);
  209. return ret;
  210. }
  211. ret = spi_find_chip_select(bus, cs, &dev);
  212. if (ret) {
  213. debug("%s: No cs %d\n", __func__, cs);
  214. return ret;
  215. }
  216. *busp = bus;
  217. *devp = dev;
  218. return ret;
  219. }
  220. int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode,
  221. const char *drv_name, const char *dev_name,
  222. struct udevice **busp, struct spi_slave **devp)
  223. {
  224. struct udevice *bus, *dev;
  225. struct dm_spi_slave_platdata *plat;
  226. bool created = false;
  227. int ret;
  228. #if CONFIG_IS_ENABLED(OF_PLATDATA) || CONFIG_IS_ENABLED(OF_PRIOR_STAGE)
  229. ret = uclass_first_device_err(UCLASS_SPI, &bus);
  230. #else
  231. ret = uclass_get_device_by_seq(UCLASS_SPI, busnum, &bus);
  232. #endif
  233. if (ret) {
  234. printf("Invalid bus %d (err=%d)\n", busnum, ret);
  235. return ret;
  236. }
  237. ret = spi_find_chip_select(bus, cs, &dev);
  238. /*
  239. * If there is no such device, create one automatically. This means
  240. * that we don't need a device tree node or platform data for the
  241. * SPI flash chip - we will bind to the correct driver.
  242. */
  243. if (ret == -ENODEV && drv_name) {
  244. debug("%s: Binding new device '%s', busnum=%d, cs=%d, driver=%s\n",
  245. __func__, dev_name, busnum, cs, drv_name);
  246. ret = device_bind_driver(bus, drv_name, dev_name, &dev);
  247. if (ret) {
  248. debug("%s: Unable to bind driver (ret=%d)\n", __func__,
  249. ret);
  250. return ret;
  251. }
  252. plat = dev_get_parent_platdata(dev);
  253. plat->cs = cs;
  254. plat->max_hz = speed;
  255. plat->mode = mode;
  256. created = true;
  257. } else if (ret) {
  258. printf("Invalid chip select %d:%d (err=%d)\n", busnum, cs,
  259. ret);
  260. return ret;
  261. }
  262. if (!device_active(dev)) {
  263. struct spi_slave *slave;
  264. ret = device_probe(dev);
  265. if (ret)
  266. goto err;
  267. slave = dev_get_parent_priv(dev);
  268. slave->dev = dev;
  269. }
  270. plat = dev_get_parent_platdata(dev);
  271. if (!speed) {
  272. speed = plat->max_hz;
  273. mode = plat->mode;
  274. }
  275. ret = spi_set_speed_mode(bus, speed, mode);
  276. if (ret)
  277. goto err;
  278. *busp = bus;
  279. *devp = dev_get_parent_priv(dev);
  280. debug("%s: bus=%p, slave=%p\n", __func__, bus, *devp);
  281. return 0;
  282. err:
  283. debug("%s: Error path, created=%d, device '%s'\n", __func__,
  284. created, dev->name);
  285. if (created) {
  286. device_remove(dev, DM_REMOVE_NORMAL);
  287. device_unbind(dev);
  288. }
  289. return ret;
  290. }
  291. /* Compatibility function - to be removed */
  292. struct spi_slave *spi_setup_slave(unsigned int busnum, unsigned int cs,
  293. unsigned int speed, unsigned int mode)
  294. {
  295. struct spi_slave *slave;
  296. struct udevice *dev;
  297. int ret;
  298. ret = spi_get_bus_and_cs(busnum, cs, speed, mode, NULL, 0, &dev,
  299. &slave);
  300. if (ret)
  301. return NULL;
  302. return slave;
  303. }
  304. void spi_free_slave(struct spi_slave *slave)
  305. {
  306. device_remove(slave->dev, DM_REMOVE_NORMAL);
  307. slave->dev = NULL;
  308. }
  309. int spi_slave_ofdata_to_platdata(struct udevice *dev,
  310. struct dm_spi_slave_platdata *plat)
  311. {
  312. int mode = 0;
  313. int value;
  314. plat->cs = dev_read_u32_default(dev, "reg", -1);
  315. plat->max_hz = dev_read_u32_default(dev, "spi-max-frequency", 0);
  316. if (dev_read_bool(dev, "spi-cpol"))
  317. mode |= SPI_CPOL;
  318. if (dev_read_bool(dev, "spi-cpha"))
  319. mode |= SPI_CPHA;
  320. if (dev_read_bool(dev, "spi-cs-high"))
  321. mode |= SPI_CS_HIGH;
  322. if (dev_read_bool(dev, "spi-3wire"))
  323. mode |= SPI_3WIRE;
  324. if (dev_read_bool(dev, "spi-half-duplex"))
  325. mode |= SPI_PREAMBLE;
  326. /* Device DUAL/QUAD mode */
  327. value = dev_read_u32_default(dev, "spi-tx-bus-width", 1);
  328. switch (value) {
  329. case 1:
  330. break;
  331. case 2:
  332. mode |= SPI_TX_DUAL;
  333. break;
  334. case 4:
  335. mode |= SPI_TX_QUAD;
  336. break;
  337. default:
  338. warn_non_spl("spi-tx-bus-width %d not supported\n", value);
  339. break;
  340. }
  341. value = dev_read_u32_default(dev, "spi-rx-bus-width", 1);
  342. switch (value) {
  343. case 1:
  344. break;
  345. case 2:
  346. mode |= SPI_RX_DUAL;
  347. break;
  348. case 4:
  349. mode |= SPI_RX_QUAD;
  350. break;
  351. default:
  352. warn_non_spl("spi-rx-bus-width %d not supported\n", value);
  353. break;
  354. }
  355. plat->mode = mode;
  356. return 0;
  357. }
  358. UCLASS_DRIVER(spi) = {
  359. .id = UCLASS_SPI,
  360. .name = "spi",
  361. .flags = DM_UC_FLAG_SEQ_ALIAS,
  362. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  363. .post_bind = dm_scan_fdt_dev,
  364. #endif
  365. .post_probe = spi_post_probe,
  366. .child_pre_probe = spi_child_pre_probe,
  367. .per_device_auto_alloc_size = sizeof(struct dm_spi_bus),
  368. .per_child_auto_alloc_size = sizeof(struct spi_slave),
  369. .per_child_platdata_auto_alloc_size =
  370. sizeof(struct dm_spi_slave_platdata),
  371. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  372. .child_post_bind = spi_child_post_bind,
  373. #endif
  374. };
  375. UCLASS_DRIVER(spi_generic) = {
  376. .id = UCLASS_SPI_GENERIC,
  377. .name = "spi_generic",
  378. };
  379. U_BOOT_DRIVER(spi_generic_drv) = {
  380. .name = "spi_generic_drv",
  381. .id = UCLASS_SPI_GENERIC,
  382. };