spi-uclass.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Copyright (c) 2014 Google, Inc
  4. */
  5. #define LOG_CATEGORY UCLASS_SPI
  6. #include <common.h>
  7. #include <dm.h>
  8. #include <errno.h>
  9. #include <log.h>
  10. #include <malloc.h>
  11. #include <spi.h>
  12. #include <spi-mem.h>
  13. #include <dm/device_compat.h>
  14. #include <asm/global_data.h>
  15. #include <dm/device-internal.h>
  16. #include <dm/uclass-internal.h>
  17. #include <dm/lists.h>
  18. #include <dm/util.h>
  19. DECLARE_GLOBAL_DATA_PTR;
  20. #define SPI_DEFAULT_SPEED_HZ 100000
  21. static int spi_set_speed_mode(struct udevice *bus, int speed, int mode)
  22. {
  23. struct dm_spi_ops *ops;
  24. int ret;
  25. ops = spi_get_ops(bus);
  26. if (ops->set_speed)
  27. ret = ops->set_speed(bus, speed);
  28. else
  29. ret = -EINVAL;
  30. if (ret) {
  31. dev_err(bus, "Cannot set speed (err=%d)\n", ret);
  32. return ret;
  33. }
  34. if (ops->set_mode)
  35. ret = ops->set_mode(bus, mode);
  36. else
  37. ret = -EINVAL;
  38. if (ret) {
  39. dev_err(bus, "Cannot set mode (err=%d)\n", ret);
  40. return ret;
  41. }
  42. return 0;
  43. }
  44. int dm_spi_claim_bus(struct udevice *dev)
  45. {
  46. struct udevice *bus = dev->parent;
  47. struct dm_spi_ops *ops = spi_get_ops(bus);
  48. struct dm_spi_bus *spi = dev_get_uclass_priv(bus);
  49. struct spi_slave *slave = dev_get_parent_priv(dev);
  50. uint speed, mode;
  51. speed = slave->max_hz;
  52. mode = slave->mode;
  53. if (spi->max_hz) {
  54. if (speed)
  55. speed = min(speed, spi->max_hz);
  56. else
  57. speed = spi->max_hz;
  58. }
  59. if (!speed)
  60. speed = SPI_DEFAULT_SPEED_HZ;
  61. if (speed != spi->speed || mode != spi->mode) {
  62. int ret = spi_set_speed_mode(bus, speed, slave->mode);
  63. if (ret)
  64. return log_ret(ret);
  65. spi->speed = speed;
  66. spi->mode = mode;
  67. }
  68. return log_ret(ops->claim_bus ? ops->claim_bus(dev) : 0);
  69. }
  70. void dm_spi_release_bus(struct udevice *dev)
  71. {
  72. struct udevice *bus = dev->parent;
  73. struct dm_spi_ops *ops = spi_get_ops(bus);
  74. if (ops->release_bus)
  75. ops->release_bus(dev);
  76. }
  77. int dm_spi_xfer(struct udevice *dev, unsigned int bitlen,
  78. const void *dout, void *din, unsigned long flags)
  79. {
  80. struct udevice *bus = dev->parent;
  81. struct dm_spi_ops *ops = spi_get_ops(bus);
  82. if (bus->uclass->uc_drv->id != UCLASS_SPI)
  83. return -EOPNOTSUPP;
  84. if (!ops->xfer)
  85. return -ENOSYS;
  86. return ops->xfer(dev, bitlen, dout, din, flags);
  87. }
  88. int dm_spi_get_mmap(struct udevice *dev, ulong *map_basep, uint *map_sizep,
  89. uint *offsetp)
  90. {
  91. struct udevice *bus = dev->parent;
  92. struct dm_spi_ops *ops = spi_get_ops(bus);
  93. if (bus->uclass->uc_drv->id != UCLASS_SPI)
  94. return -EOPNOTSUPP;
  95. if (!ops->get_mmap)
  96. return -ENOSYS;
  97. return ops->get_mmap(dev, map_basep, map_sizep, offsetp);
  98. }
  99. int spi_claim_bus(struct spi_slave *slave)
  100. {
  101. return log_ret(dm_spi_claim_bus(slave->dev));
  102. }
  103. void spi_release_bus(struct spi_slave *slave)
  104. {
  105. dm_spi_release_bus(slave->dev);
  106. }
  107. int spi_xfer(struct spi_slave *slave, unsigned int bitlen,
  108. const void *dout, void *din, unsigned long flags)
  109. {
  110. return dm_spi_xfer(slave->dev, bitlen, dout, din, flags);
  111. }
  112. int spi_write_then_read(struct spi_slave *slave, const u8 *opcode,
  113. size_t n_opcode, const u8 *txbuf, u8 *rxbuf,
  114. size_t n_buf)
  115. {
  116. unsigned long flags = SPI_XFER_BEGIN;
  117. int ret;
  118. if (n_buf == 0)
  119. flags |= SPI_XFER_END;
  120. ret = spi_xfer(slave, n_opcode * 8, opcode, NULL, flags);
  121. if (ret) {
  122. dev_dbg(slave->dev,
  123. "spi: failed to send command (%zu bytes): %d\n",
  124. n_opcode, ret);
  125. } else if (n_buf != 0) {
  126. ret = spi_xfer(slave, n_buf * 8, txbuf, rxbuf, SPI_XFER_END);
  127. if (ret)
  128. dev_dbg(slave->dev,
  129. "spi: failed to transfer %zu bytes of data: %d\n",
  130. n_buf, ret);
  131. }
  132. return ret;
  133. }
  134. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  135. static int spi_child_post_bind(struct udevice *dev)
  136. {
  137. struct dm_spi_slave_plat *plat = dev_get_parent_plat(dev);
  138. if (!dev_has_ofnode(dev))
  139. return 0;
  140. return spi_slave_of_to_plat(dev, plat);
  141. }
  142. #endif
  143. static int spi_post_probe(struct udevice *bus)
  144. {
  145. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  146. struct dm_spi_bus *spi = dev_get_uclass_priv(bus);
  147. spi->max_hz = dev_read_u32_default(bus, "spi-max-frequency", 0);
  148. #endif
  149. #if defined(CONFIG_NEEDS_MANUAL_RELOC)
  150. struct dm_spi_ops *ops = spi_get_ops(bus);
  151. static int reloc_done;
  152. if (!reloc_done) {
  153. if (ops->claim_bus)
  154. ops->claim_bus += gd->reloc_off;
  155. if (ops->release_bus)
  156. ops->release_bus += gd->reloc_off;
  157. if (ops->set_wordlen)
  158. ops->set_wordlen += gd->reloc_off;
  159. if (ops->xfer)
  160. ops->xfer += gd->reloc_off;
  161. if (ops->set_speed)
  162. ops->set_speed += gd->reloc_off;
  163. if (ops->set_mode)
  164. ops->set_mode += gd->reloc_off;
  165. if (ops->cs_info)
  166. ops->cs_info += gd->reloc_off;
  167. if (ops->mem_ops) {
  168. struct spi_controller_mem_ops *mem_ops =
  169. (struct spi_controller_mem_ops *)ops->mem_ops;
  170. if (mem_ops->adjust_op_size)
  171. mem_ops->adjust_op_size += gd->reloc_off;
  172. if (mem_ops->supports_op)
  173. mem_ops->supports_op += gd->reloc_off;
  174. if (mem_ops->exec_op)
  175. mem_ops->exec_op += gd->reloc_off;
  176. }
  177. reloc_done++;
  178. }
  179. #endif
  180. return 0;
  181. }
  182. static int spi_child_pre_probe(struct udevice *dev)
  183. {
  184. struct dm_spi_slave_plat *plat = dev_get_parent_plat(dev);
  185. struct spi_slave *slave = dev_get_parent_priv(dev);
  186. /*
  187. * This is needed because we pass struct spi_slave around the place
  188. * instead slave->dev (a struct udevice). So we have to have some
  189. * way to access the slave udevice given struct spi_slave. Once we
  190. * change the SPI API to use udevice instead of spi_slave, we can
  191. * drop this.
  192. */
  193. slave->dev = dev;
  194. slave->max_hz = plat->max_hz;
  195. slave->mode = plat->mode;
  196. slave->wordlen = SPI_DEFAULT_WORDLEN;
  197. return 0;
  198. }
  199. int spi_chip_select(struct udevice *dev)
  200. {
  201. struct dm_spi_slave_plat *plat = dev_get_parent_plat(dev);
  202. return plat ? plat->cs : -ENOENT;
  203. }
  204. int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp)
  205. {
  206. struct dm_spi_ops *ops;
  207. struct spi_cs_info info;
  208. struct udevice *dev;
  209. int ret;
  210. /*
  211. * Ask the driver. For the moment we don't have CS info.
  212. * When we do we could provide the driver with a helper function
  213. * to figure out what chip selects are valid, or just handle the
  214. * request.
  215. */
  216. ops = spi_get_ops(bus);
  217. if (ops->cs_info) {
  218. ret = ops->cs_info(bus, cs, &info);
  219. } else {
  220. /*
  221. * We could assume there is at least one valid chip select.
  222. * The driver didn't care enough to tell us.
  223. */
  224. ret = 0;
  225. }
  226. if (ret) {
  227. dev_err(bus, "Invalid cs %d (err=%d)\n", cs, ret);
  228. return ret;
  229. }
  230. for (device_find_first_child(bus, &dev); dev;
  231. device_find_next_child(&dev)) {
  232. struct dm_spi_slave_plat *plat;
  233. plat = dev_get_parent_plat(dev);
  234. dev_dbg(bus, "%s: plat=%p, cs=%d\n", __func__, plat, plat->cs);
  235. if (plat->cs == cs) {
  236. *devp = dev;
  237. return 0;
  238. }
  239. }
  240. return -ENODEV;
  241. }
  242. int spi_cs_is_valid(unsigned int busnum, unsigned int cs)
  243. {
  244. struct spi_cs_info info;
  245. struct udevice *bus;
  246. int ret;
  247. ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, &bus);
  248. if (ret) {
  249. log_debug("%s: No bus %d\n", __func__, busnum);
  250. return ret;
  251. }
  252. return spi_cs_info(bus, cs, &info);
  253. }
  254. int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info)
  255. {
  256. struct spi_cs_info local_info;
  257. int ret;
  258. if (!info)
  259. info = &local_info;
  260. /* If there is a device attached, return it */
  261. info->dev = NULL;
  262. ret = spi_find_chip_select(bus, cs, &info->dev);
  263. return ret == -ENODEV ? 0 : ret;
  264. }
  265. int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp,
  266. struct udevice **devp)
  267. {
  268. struct udevice *bus, *dev;
  269. int ret;
  270. ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, &bus);
  271. if (ret) {
  272. log_debug("%s: No bus %d\n", __func__, busnum);
  273. return ret;
  274. }
  275. ret = spi_find_chip_select(bus, cs, &dev);
  276. if (ret) {
  277. dev_dbg(bus, "%s: No cs %d\n", __func__, cs);
  278. return ret;
  279. }
  280. *busp = bus;
  281. *devp = dev;
  282. return ret;
  283. }
  284. int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode,
  285. const char *drv_name, const char *dev_name,
  286. struct udevice **busp, struct spi_slave **devp)
  287. {
  288. struct udevice *bus, *dev;
  289. struct dm_spi_slave_plat *plat;
  290. struct dm_spi_bus *bus_data;
  291. struct spi_slave *slave;
  292. bool created = false;
  293. int ret;
  294. #if CONFIG_IS_ENABLED(OF_PLATDATA)
  295. ret = uclass_first_device_err(UCLASS_SPI, &bus);
  296. #else
  297. ret = uclass_get_device_by_seq(UCLASS_SPI, busnum, &bus);
  298. #endif
  299. if (ret) {
  300. log_err("Invalid bus %d (err=%d)\n", busnum, ret);
  301. return ret;
  302. }
  303. ret = spi_find_chip_select(bus, cs, &dev);
  304. /*
  305. * If there is no such device, create one automatically. This means
  306. * that we don't need a device tree node or platform data for the
  307. * SPI flash chip - we will bind to the correct driver.
  308. */
  309. if (ret == -ENODEV && drv_name) {
  310. dev_dbg(bus, "%s: Binding new device '%s', busnum=%d, cs=%d, driver=%s\n",
  311. __func__, dev_name, busnum, cs, drv_name);
  312. ret = device_bind_driver(bus, drv_name, dev_name, &dev);
  313. if (ret) {
  314. dev_dbg(bus, "%s: Unable to bind driver (ret=%d)\n",
  315. __func__, ret);
  316. return ret;
  317. }
  318. plat = dev_get_parent_plat(dev);
  319. plat->cs = cs;
  320. if (speed) {
  321. plat->max_hz = speed;
  322. } else {
  323. dev_warn(bus,
  324. "Warning: SPI speed fallback to %u kHz\n",
  325. SPI_DEFAULT_SPEED_HZ / 1000);
  326. plat->max_hz = SPI_DEFAULT_SPEED_HZ;
  327. }
  328. plat->mode = mode;
  329. created = true;
  330. } else if (ret) {
  331. dev_err(bus, "Invalid chip select %d:%d (err=%d)\n", busnum, cs, ret);
  332. return ret;
  333. } else if (dev) {
  334. plat = dev_get_parent_plat(dev);
  335. }
  336. if (!device_active(dev)) {
  337. struct spi_slave *slave;
  338. ret = device_probe(dev);
  339. if (ret)
  340. goto err;
  341. slave = dev_get_parent_priv(dev);
  342. slave->dev = dev;
  343. }
  344. slave = dev_get_parent_priv(dev);
  345. bus_data = dev_get_uclass_priv(bus);
  346. /*
  347. * In case the operation speed is not yet established by
  348. * dm_spi_claim_bus() ensure the bus is configured properly.
  349. */
  350. if (!bus_data->speed) {
  351. ret = spi_claim_bus(slave);
  352. if (ret)
  353. goto err;
  354. }
  355. /* In case bus frequency or mode changed, update it. */
  356. if ((speed && bus_data->speed && bus_data->speed != speed) ||
  357. (plat && plat->mode != mode)) {
  358. ret = spi_set_speed_mode(bus, speed, mode);
  359. if (ret)
  360. goto err_speed_mode;
  361. }
  362. *busp = bus;
  363. *devp = slave;
  364. log_debug("%s: bus=%p, slave=%p\n", __func__, bus, *devp);
  365. return 0;
  366. err_speed_mode:
  367. spi_release_bus(slave);
  368. err:
  369. log_debug("%s: Error path, created=%d, device '%s'\n", __func__,
  370. created, dev->name);
  371. if (created) {
  372. device_remove(dev, DM_REMOVE_NORMAL);
  373. device_unbind(dev);
  374. }
  375. return ret;
  376. }
  377. /* Compatibility function - to be removed */
  378. struct spi_slave *spi_setup_slave(unsigned int busnum, unsigned int cs,
  379. unsigned int speed, unsigned int mode)
  380. {
  381. struct spi_slave *slave;
  382. struct udevice *dev;
  383. int ret;
  384. ret = spi_get_bus_and_cs(busnum, cs, speed, mode, NULL, 0, &dev,
  385. &slave);
  386. if (ret)
  387. return NULL;
  388. return slave;
  389. }
  390. void spi_free_slave(struct spi_slave *slave)
  391. {
  392. device_remove(slave->dev, DM_REMOVE_NORMAL);
  393. }
  394. int spi_slave_of_to_plat(struct udevice *dev, struct dm_spi_slave_plat *plat)
  395. {
  396. int mode = 0;
  397. int value;
  398. plat->cs = dev_read_u32_default(dev, "reg", -1);
  399. plat->max_hz = dev_read_u32_default(dev, "spi-max-frequency",
  400. SPI_DEFAULT_SPEED_HZ);
  401. if (dev_read_bool(dev, "spi-cpol"))
  402. mode |= SPI_CPOL;
  403. if (dev_read_bool(dev, "spi-cpha"))
  404. mode |= SPI_CPHA;
  405. if (dev_read_bool(dev, "spi-cs-high"))
  406. mode |= SPI_CS_HIGH;
  407. if (dev_read_bool(dev, "spi-3wire"))
  408. mode |= SPI_3WIRE;
  409. if (dev_read_bool(dev, "spi-half-duplex"))
  410. mode |= SPI_PREAMBLE;
  411. /* Device DUAL/QUAD mode */
  412. value = dev_read_u32_default(dev, "spi-tx-bus-width", 1);
  413. switch (value) {
  414. case 1:
  415. break;
  416. case 2:
  417. mode |= SPI_TX_DUAL;
  418. break;
  419. case 4:
  420. mode |= SPI_TX_QUAD;
  421. break;
  422. case 8:
  423. mode |= SPI_TX_OCTAL;
  424. break;
  425. default:
  426. warn_non_spl("spi-tx-bus-width %d not supported\n", value);
  427. break;
  428. }
  429. value = dev_read_u32_default(dev, "spi-rx-bus-width", 1);
  430. switch (value) {
  431. case 1:
  432. break;
  433. case 2:
  434. mode |= SPI_RX_DUAL;
  435. break;
  436. case 4:
  437. mode |= SPI_RX_QUAD;
  438. break;
  439. case 8:
  440. mode |= SPI_RX_OCTAL;
  441. break;
  442. default:
  443. warn_non_spl("spi-rx-bus-width %d not supported\n", value);
  444. break;
  445. }
  446. plat->mode = mode;
  447. return 0;
  448. }
  449. UCLASS_DRIVER(spi) = {
  450. .id = UCLASS_SPI,
  451. .name = "spi",
  452. .flags = DM_UC_FLAG_SEQ_ALIAS,
  453. #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
  454. .post_bind = dm_scan_fdt_dev,
  455. #endif
  456. .post_probe = spi_post_probe,
  457. .child_pre_probe = spi_child_pre_probe,
  458. .per_device_auto = sizeof(struct dm_spi_bus),
  459. .per_child_auto = sizeof(struct spi_slave),
  460. .per_child_plat_auto = sizeof(struct dm_spi_slave_plat),
  461. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  462. .child_post_bind = spi_child_post_bind,
  463. #endif
  464. };
  465. UCLASS_DRIVER(spi_generic) = {
  466. .id = UCLASS_SPI_GENERIC,
  467. .name = "spi_generic",
  468. };
  469. U_BOOT_DRIVER(spi_generic_drv) = {
  470. .name = "spi_generic_drv",
  471. .id = UCLASS_SPI_GENERIC,
  472. };