spi.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893
  1. /*
  2. * spi.c - SPI init/core code
  3. *
  4. * Copyright (C) 2005 David Brownell
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, write to the Free Software
  18. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19. */
  20. #include <linux/kernel.h>
  21. #include <linux/device.h>
  22. #include <linux/init.h>
  23. #include <linux/cache.h>
  24. #include <linux/mutex.h>
  25. #include <linux/mod_devicetable.h>
  26. #include <linux/spi/spi.h>
  27. /* SPI bustype and spi_master class are registered after board init code
  28. * provides the SPI device tables, ensuring that both are present by the
  29. * time controller driver registration causes spi_devices to "enumerate".
  30. */
  31. static void spidev_release(struct device *dev)
  32. {
  33. struct spi_device *spi = to_spi_device(dev);
  34. /* spi masters may cleanup for released devices */
  35. if (spi->master->cleanup)
  36. spi->master->cleanup(spi);
  37. spi_master_put(spi->master);
  38. kfree(dev);
  39. }
  40. static ssize_t
  41. modalias_show(struct device *dev, struct device_attribute *a, char *buf)
  42. {
  43. const struct spi_device *spi = to_spi_device(dev);
  44. return sprintf(buf, "%s\n", spi->modalias);
  45. }
  46. static struct device_attribute spi_dev_attrs[] = {
  47. __ATTR_RO(modalias),
  48. __ATTR_NULL,
  49. };
  50. /* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
  51. * and the sysfs version makes coldplug work too.
  52. */
  53. static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
  54. const struct spi_device *sdev)
  55. {
  56. while (id->name[0]) {
  57. if (!strcmp(sdev->modalias, id->name))
  58. return id;
  59. id++;
  60. }
  61. return NULL;
  62. }
  63. const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
  64. {
  65. const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
  66. return spi_match_id(sdrv->id_table, sdev);
  67. }
  68. EXPORT_SYMBOL_GPL(spi_get_device_id);
  69. static int spi_match_device(struct device *dev, struct device_driver *drv)
  70. {
  71. const struct spi_device *spi = to_spi_device(dev);
  72. const struct spi_driver *sdrv = to_spi_driver(drv);
  73. if (sdrv->id_table)
  74. return !!spi_match_id(sdrv->id_table, spi);
  75. return strcmp(spi->modalias, drv->name) == 0;
  76. }
  77. static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
  78. {
  79. const struct spi_device *spi = to_spi_device(dev);
  80. add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
  81. return 0;
  82. }
  83. #ifdef CONFIG_PM
  84. static int spi_suspend(struct device *dev, pm_message_t message)
  85. {
  86. int value = 0;
  87. struct spi_driver *drv = to_spi_driver(dev->driver);
  88. /* suspend will stop irqs and dma; no more i/o */
  89. if (drv) {
  90. if (drv->suspend)
  91. value = drv->suspend(to_spi_device(dev), message);
  92. else
  93. dev_dbg(dev, "... can't suspend\n");
  94. }
  95. return value;
  96. }
  97. static int spi_resume(struct device *dev)
  98. {
  99. int value = 0;
  100. struct spi_driver *drv = to_spi_driver(dev->driver);
  101. /* resume may restart the i/o queue */
  102. if (drv) {
  103. if (drv->resume)
  104. value = drv->resume(to_spi_device(dev));
  105. else
  106. dev_dbg(dev, "... can't resume\n");
  107. }
  108. return value;
  109. }
  110. #else
  111. #define spi_suspend NULL
  112. #define spi_resume NULL
  113. #endif
  114. struct bus_type spi_bus_type = {
  115. .name = "spi",
  116. .dev_attrs = spi_dev_attrs,
  117. .match = spi_match_device,
  118. .uevent = spi_uevent,
  119. .suspend = spi_suspend,
  120. .resume = spi_resume,
  121. };
  122. EXPORT_SYMBOL_GPL(spi_bus_type);
  123. static int spi_drv_probe(struct device *dev)
  124. {
  125. const struct spi_driver *sdrv = to_spi_driver(dev->driver);
  126. return sdrv->probe(to_spi_device(dev));
  127. }
  128. static int spi_drv_remove(struct device *dev)
  129. {
  130. const struct spi_driver *sdrv = to_spi_driver(dev->driver);
  131. return sdrv->remove(to_spi_device(dev));
  132. }
  133. static void spi_drv_shutdown(struct device *dev)
  134. {
  135. const struct spi_driver *sdrv = to_spi_driver(dev->driver);
  136. sdrv->shutdown(to_spi_device(dev));
  137. }
  138. /**
  139. * spi_register_driver - register a SPI driver
  140. * @sdrv: the driver to register
  141. * Context: can sleep
  142. */
  143. int spi_register_driver(struct spi_driver *sdrv)
  144. {
  145. sdrv->driver.bus = &spi_bus_type;
  146. if (sdrv->probe)
  147. sdrv->driver.probe = spi_drv_probe;
  148. if (sdrv->remove)
  149. sdrv->driver.remove = spi_drv_remove;
  150. if (sdrv->shutdown)
  151. sdrv->driver.shutdown = spi_drv_shutdown;
  152. return driver_register(&sdrv->driver);
  153. }
  154. EXPORT_SYMBOL_GPL(spi_register_driver);
  155. /*-------------------------------------------------------------------------*/
  156. /* SPI devices should normally not be created by SPI device drivers; that
  157. * would make them board-specific. Similarly with SPI master drivers.
  158. * Device registration normally goes into like arch/.../mach.../board-YYY.c
  159. * with other readonly (flashable) information about mainboard devices.
  160. */
  161. struct boardinfo {
  162. struct list_head list;
  163. unsigned n_board_info;
  164. struct spi_board_info board_info[0];
  165. };
  166. static LIST_HEAD(board_list);
  167. static DEFINE_MUTEX(board_lock);
  168. /**
  169. * spi_alloc_device - Allocate a new SPI device
  170. * @master: Controller to which device is connected
  171. * Context: can sleep
  172. *
  173. * Allows a driver to allocate and initialize a spi_device without
  174. * registering it immediately. This allows a driver to directly
  175. * fill the spi_device with device parameters before calling
  176. * spi_add_device() on it.
  177. *
  178. * Caller is responsible to call spi_add_device() on the returned
  179. * spi_device structure to add it to the SPI master. If the caller
  180. * needs to discard the spi_device without adding it, then it should
  181. * call spi_dev_put() on it.
  182. *
  183. * Returns a pointer to the new device, or NULL.
  184. */
  185. struct spi_device *spi_alloc_device(struct spi_master *master)
  186. {
  187. struct spi_device *spi;
  188. struct device *dev = master->dev.parent;
  189. if (!spi_master_get(master))
  190. return NULL;
  191. spi = kzalloc(sizeof *spi, GFP_KERNEL);
  192. if (!spi) {
  193. dev_err(dev, "cannot alloc spi_device\n");
  194. spi_master_put(master);
  195. return NULL;
  196. }
  197. spi->master = master;
  198. spi->dev.parent = dev;
  199. spi->dev.bus = &spi_bus_type;
  200. spi->dev.release = spidev_release;
  201. device_initialize(&spi->dev);
  202. return spi;
  203. }
  204. EXPORT_SYMBOL_GPL(spi_alloc_device);
  205. /**
  206. * spi_add_device - Add spi_device allocated with spi_alloc_device
  207. * @spi: spi_device to register
  208. *
  209. * Companion function to spi_alloc_device. Devices allocated with
  210. * spi_alloc_device can be added onto the spi bus with this function.
  211. *
  212. * Returns 0 on success; negative errno on failure
  213. */
  214. int spi_add_device(struct spi_device *spi)
  215. {
  216. static DEFINE_MUTEX(spi_add_lock);
  217. struct device *dev = spi->master->dev.parent;
  218. int status;
  219. /* Chipselects are numbered 0..max; validate. */
  220. if (spi->chip_select >= spi->master->num_chipselect) {
  221. dev_err(dev, "cs%d >= max %d\n",
  222. spi->chip_select,
  223. spi->master->num_chipselect);
  224. return -EINVAL;
  225. }
  226. /* Set the bus ID string */
  227. dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),
  228. spi->chip_select);
  229. /* We need to make sure there's no other device with this
  230. * chipselect **BEFORE** we call setup(), else we'll trash
  231. * its configuration. Lock against concurrent add() calls.
  232. */
  233. mutex_lock(&spi_add_lock);
  234. if (bus_find_device_by_name(&spi_bus_type, NULL, dev_name(&spi->dev))
  235. != NULL) {
  236. dev_err(dev, "chipselect %d already in use\n",
  237. spi->chip_select);
  238. status = -EBUSY;
  239. goto done;
  240. }
  241. /* Drivers may modify this initial i/o setup, but will
  242. * normally rely on the device being setup. Devices
  243. * using SPI_CS_HIGH can't coexist well otherwise...
  244. */
  245. status = spi_setup(spi);
  246. if (status < 0) {
  247. dev_err(dev, "can't %s %s, status %d\n",
  248. "setup", dev_name(&spi->dev), status);
  249. goto done;
  250. }
  251. /* Device may be bound to an active driver when this returns */
  252. status = device_add(&spi->dev);
  253. if (status < 0)
  254. dev_err(dev, "can't %s %s, status %d\n",
  255. "add", dev_name(&spi->dev), status);
  256. else
  257. dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
  258. done:
  259. mutex_unlock(&spi_add_lock);
  260. return status;
  261. }
  262. EXPORT_SYMBOL_GPL(spi_add_device);
  263. /**
  264. * spi_new_device - instantiate one new SPI device
  265. * @master: Controller to which device is connected
  266. * @chip: Describes the SPI device
  267. * Context: can sleep
  268. *
  269. * On typical mainboards, this is purely internal; and it's not needed
  270. * after board init creates the hard-wired devices. Some development
  271. * platforms may not be able to use spi_register_board_info though, and
  272. * this is exported so that for example a USB or parport based adapter
  273. * driver could add devices (which it would learn about out-of-band).
  274. *
  275. * Returns the new device, or NULL.
  276. */
  277. struct spi_device *spi_new_device(struct spi_master *master,
  278. struct spi_board_info *chip)
  279. {
  280. struct spi_device *proxy;
  281. int status;
  282. /* NOTE: caller did any chip->bus_num checks necessary.
  283. *
  284. * Also, unless we change the return value convention to use
  285. * error-or-pointer (not NULL-or-pointer), troubleshootability
  286. * suggests syslogged diagnostics are best here (ugh).
  287. */
  288. proxy = spi_alloc_device(master);
  289. if (!proxy)
  290. return NULL;
  291. WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
  292. proxy->chip_select = chip->chip_select;
  293. proxy->max_speed_hz = chip->max_speed_hz;
  294. proxy->mode = chip->mode;
  295. proxy->irq = chip->irq;
  296. strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
  297. proxy->dev.platform_data = (void *) chip->platform_data;
  298. proxy->controller_data = chip->controller_data;
  299. proxy->controller_state = NULL;
  300. status = spi_add_device(proxy);
  301. if (status < 0) {
  302. spi_dev_put(proxy);
  303. return NULL;
  304. }
  305. return proxy;
  306. }
  307. EXPORT_SYMBOL_GPL(spi_new_device);
  308. /**
  309. * spi_register_board_info - register SPI devices for a given board
  310. * @info: array of chip descriptors
  311. * @n: how many descriptors are provided
  312. * Context: can sleep
  313. *
  314. * Board-specific early init code calls this (probably during arch_initcall)
  315. * with segments of the SPI device table. Any device nodes are created later,
  316. * after the relevant parent SPI controller (bus_num) is defined. We keep
  317. * this table of devices forever, so that reloading a controller driver will
  318. * not make Linux forget about these hard-wired devices.
  319. *
  320. * Other code can also call this, e.g. a particular add-on board might provide
  321. * SPI devices through its expansion connector, so code initializing that board
  322. * would naturally declare its SPI devices.
  323. *
  324. * The board info passed can safely be __initdata ... but be careful of
  325. * any embedded pointers (platform_data, etc), they're copied as-is.
  326. */
  327. int __init
  328. spi_register_board_info(struct spi_board_info const *info, unsigned n)
  329. {
  330. struct boardinfo *bi;
  331. bi = kmalloc(sizeof(*bi) + n * sizeof *info, GFP_KERNEL);
  332. if (!bi)
  333. return -ENOMEM;
  334. bi->n_board_info = n;
  335. memcpy(bi->board_info, info, n * sizeof *info);
  336. mutex_lock(&board_lock);
  337. list_add_tail(&bi->list, &board_list);
  338. mutex_unlock(&board_lock);
  339. return 0;
  340. }
  341. /* FIXME someone should add support for a __setup("spi", ...) that
  342. * creates board info from kernel command lines
  343. */
  344. static void scan_boardinfo(struct spi_master *master)
  345. {
  346. struct boardinfo *bi;
  347. mutex_lock(&board_lock);
  348. list_for_each_entry(bi, &board_list, list) {
  349. struct spi_board_info *chip = bi->board_info;
  350. unsigned n;
  351. for (n = bi->n_board_info; n > 0; n--, chip++) {
  352. if (chip->bus_num != master->bus_num)
  353. continue;
  354. /* NOTE: this relies on spi_new_device to
  355. * issue diagnostics when given bogus inputs
  356. */
  357. (void) spi_new_device(master, chip);
  358. }
  359. }
  360. mutex_unlock(&board_lock);
  361. }
  362. /*-------------------------------------------------------------------------*/
  363. static void spi_master_release(struct device *dev)
  364. {
  365. struct spi_master *master;
  366. master = container_of(dev, struct spi_master, dev);
  367. kfree(master);
  368. }
  369. static struct class spi_master_class = {
  370. .name = "spi_master",
  371. .owner = THIS_MODULE,
  372. .dev_release = spi_master_release,
  373. };
  374. /**
  375. * spi_alloc_master - allocate SPI master controller
  376. * @dev: the controller, possibly using the platform_bus
  377. * @size: how much zeroed driver-private data to allocate; the pointer to this
  378. * memory is in the driver_data field of the returned device,
  379. * accessible with spi_master_get_devdata().
  380. * Context: can sleep
  381. *
  382. * This call is used only by SPI master controller drivers, which are the
  383. * only ones directly touching chip registers. It's how they allocate
  384. * an spi_master structure, prior to calling spi_register_master().
  385. *
  386. * This must be called from context that can sleep. It returns the SPI
  387. * master structure on success, else NULL.
  388. *
  389. * The caller is responsible for assigning the bus number and initializing
  390. * the master's methods before calling spi_register_master(); and (after errors
  391. * adding the device) calling spi_master_put() to prevent a memory leak.
  392. */
  393. struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
  394. {
  395. struct spi_master *master;
  396. if (!dev)
  397. return NULL;
  398. master = kzalloc(size + sizeof *master, GFP_KERNEL);
  399. if (!master)
  400. return NULL;
  401. device_initialize(&master->dev);
  402. master->dev.class = &spi_master_class;
  403. master->dev.parent = get_device(dev);
  404. spi_master_set_devdata(master, &master[1]);
  405. return master;
  406. }
  407. EXPORT_SYMBOL_GPL(spi_alloc_master);
  408. /**
  409. * spi_register_master - register SPI master controller
  410. * @master: initialized master, originally from spi_alloc_master()
  411. * Context: can sleep
  412. *
  413. * SPI master controllers connect to their drivers using some non-SPI bus,
  414. * such as the platform bus. The final stage of probe() in that code
  415. * includes calling spi_register_master() to hook up to this SPI bus glue.
  416. *
  417. * SPI controllers use board specific (often SOC specific) bus numbers,
  418. * and board-specific addressing for SPI devices combines those numbers
  419. * with chip select numbers. Since SPI does not directly support dynamic
  420. * device identification, boards need configuration tables telling which
  421. * chip is at which address.
  422. *
  423. * This must be called from context that can sleep. It returns zero on
  424. * success, else a negative error code (dropping the master's refcount).
  425. * After a successful return, the caller is responsible for calling
  426. * spi_unregister_master().
  427. */
  428. int spi_register_master(struct spi_master *master)
  429. {
  430. static atomic_t dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
  431. struct device *dev = master->dev.parent;
  432. int status = -ENODEV;
  433. int dynamic = 0;
  434. if (!dev)
  435. return -ENODEV;
  436. /* even if it's just one always-selected device, there must
  437. * be at least one chipselect
  438. */
  439. if (master->num_chipselect == 0)
  440. return -EINVAL;
  441. /* convention: dynamically assigned bus IDs count down from the max */
  442. if (master->bus_num < 0) {
  443. /* FIXME switch to an IDR based scheme, something like
  444. * I2C now uses, so we can't run out of "dynamic" IDs
  445. */
  446. master->bus_num = atomic_dec_return(&dyn_bus_id);
  447. dynamic = 1;
  448. }
  449. /* register the device, then userspace will see it.
  450. * registration fails if the bus ID is in use.
  451. */
  452. dev_set_name(&master->dev, "spi%u", master->bus_num);
  453. status = device_add(&master->dev);
  454. if (status < 0)
  455. goto done;
  456. dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),
  457. dynamic ? " (dynamic)" : "");
  458. /* populate children from any spi device tables */
  459. scan_boardinfo(master);
  460. status = 0;
  461. done:
  462. return status;
  463. }
  464. EXPORT_SYMBOL_GPL(spi_register_master);
  465. static int __unregister(struct device *dev, void *master_dev)
  466. {
  467. /* note: before about 2.6.14-rc1 this would corrupt memory: */
  468. if (dev != master_dev)
  469. spi_unregister_device(to_spi_device(dev));
  470. return 0;
  471. }
  472. /**
  473. * spi_unregister_master - unregister SPI master controller
  474. * @master: the master being unregistered
  475. * Context: can sleep
  476. *
  477. * This call is used only by SPI master controller drivers, which are the
  478. * only ones directly touching chip registers.
  479. *
  480. * This must be called from context that can sleep.
  481. */
  482. void spi_unregister_master(struct spi_master *master)
  483. {
  484. int dummy;
  485. dummy = device_for_each_child(master->dev.parent, &master->dev,
  486. __unregister);
  487. device_unregister(&master->dev);
  488. }
  489. EXPORT_SYMBOL_GPL(spi_unregister_master);
  490. static int __spi_master_match(struct device *dev, void *data)
  491. {
  492. struct spi_master *m;
  493. u16 *bus_num = data;
  494. m = container_of(dev, struct spi_master, dev);
  495. return m->bus_num == *bus_num;
  496. }
  497. /**
  498. * spi_busnum_to_master - look up master associated with bus_num
  499. * @bus_num: the master's bus number
  500. * Context: can sleep
  501. *
  502. * This call may be used with devices that are registered after
  503. * arch init time. It returns a refcounted pointer to the relevant
  504. * spi_master (which the caller must release), or NULL if there is
  505. * no such master registered.
  506. */
  507. struct spi_master *spi_busnum_to_master(u16 bus_num)
  508. {
  509. struct device *dev;
  510. struct spi_master *master = NULL;
  511. dev = class_find_device(&spi_master_class, NULL, &bus_num,
  512. __spi_master_match);
  513. if (dev)
  514. master = container_of(dev, struct spi_master, dev);
  515. /* reference got in class_find_device */
  516. return master;
  517. }
  518. EXPORT_SYMBOL_GPL(spi_busnum_to_master);
  519. /*-------------------------------------------------------------------------*/
  520. /* Core methods for SPI master protocol drivers. Some of the
  521. * other core methods are currently defined as inline functions.
  522. */
  523. /**
  524. * spi_setup - setup SPI mode and clock rate
  525. * @spi: the device whose settings are being modified
  526. * Context: can sleep, and no requests are queued to the device
  527. *
  528. * SPI protocol drivers may need to update the transfer mode if the
  529. * device doesn't work with its default. They may likewise need
  530. * to update clock rates or word sizes from initial values. This function
  531. * changes those settings, and must be called from a context that can sleep.
  532. * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
  533. * effect the next time the device is selected and data is transferred to
  534. * or from it. When this function returns, the spi device is deselected.
  535. *
  536. * Note that this call will fail if the protocol driver specifies an option
  537. * that the underlying controller or its driver does not support. For
  538. * example, not all hardware supports wire transfers using nine bit words,
  539. * LSB-first wire encoding, or active-high chipselects.
  540. */
  541. int spi_setup(struct spi_device *spi)
  542. {
  543. unsigned bad_bits;
  544. int status;
  545. /* help drivers fail *cleanly* when they need options
  546. * that aren't supported with their current master
  547. */
  548. bad_bits = spi->mode & ~spi->master->mode_bits;
  549. if (bad_bits) {
  550. dev_dbg(&spi->dev, "setup: unsupported mode bits %x\n",
  551. bad_bits);
  552. return -EINVAL;
  553. }
  554. if (!spi->bits_per_word)
  555. spi->bits_per_word = 8;
  556. status = spi->master->setup(spi);
  557. dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s"
  558. "%u bits/w, %u Hz max --> %d\n",
  559. (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
  560. (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
  561. (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
  562. (spi->mode & SPI_3WIRE) ? "3wire, " : "",
  563. (spi->mode & SPI_LOOP) ? "loopback, " : "",
  564. spi->bits_per_word, spi->max_speed_hz,
  565. status);
  566. return status;
  567. }
  568. EXPORT_SYMBOL_GPL(spi_setup);
  569. /**
  570. * spi_async - asynchronous SPI transfer
  571. * @spi: device with which data will be exchanged
  572. * @message: describes the data transfers, including completion callback
  573. * Context: any (irqs may be blocked, etc)
  574. *
  575. * This call may be used in_irq and other contexts which can't sleep,
  576. * as well as from task contexts which can sleep.
  577. *
  578. * The completion callback is invoked in a context which can't sleep.
  579. * Before that invocation, the value of message->status is undefined.
  580. * When the callback is issued, message->status holds either zero (to
  581. * indicate complete success) or a negative error code. After that
  582. * callback returns, the driver which issued the transfer request may
  583. * deallocate the associated memory; it's no longer in use by any SPI
  584. * core or controller driver code.
  585. *
  586. * Note that although all messages to a spi_device are handled in
  587. * FIFO order, messages may go to different devices in other orders.
  588. * Some device might be higher priority, or have various "hard" access
  589. * time requirements, for example.
  590. *
  591. * On detection of any fault during the transfer, processing of
  592. * the entire message is aborted, and the device is deselected.
  593. * Until returning from the associated message completion callback,
  594. * no other spi_message queued to that device will be processed.
  595. * (This rule applies equally to all the synchronous transfer calls,
  596. * which are wrappers around this core asynchronous primitive.)
  597. */
  598. int spi_async(struct spi_device *spi, struct spi_message *message)
  599. {
  600. struct spi_master *master = spi->master;
  601. /* Half-duplex links include original MicroWire, and ones with
  602. * only one data pin like SPI_3WIRE (switches direction) or where
  603. * either MOSI or MISO is missing. They can also be caused by
  604. * software limitations.
  605. */
  606. if ((master->flags & SPI_MASTER_HALF_DUPLEX)
  607. || (spi->mode & SPI_3WIRE)) {
  608. struct spi_transfer *xfer;
  609. unsigned flags = master->flags;
  610. list_for_each_entry(xfer, &message->transfers, transfer_list) {
  611. if (xfer->rx_buf && xfer->tx_buf)
  612. return -EINVAL;
  613. if ((flags & SPI_MASTER_NO_TX) && xfer->tx_buf)
  614. return -EINVAL;
  615. if ((flags & SPI_MASTER_NO_RX) && xfer->rx_buf)
  616. return -EINVAL;
  617. }
  618. }
  619. message->spi = spi;
  620. message->status = -EINPROGRESS;
  621. return master->transfer(spi, message);
  622. }
  623. EXPORT_SYMBOL_GPL(spi_async);
  624. /*-------------------------------------------------------------------------*/
  625. /* Utility methods for SPI master protocol drivers, layered on
  626. * top of the core. Some other utility methods are defined as
  627. * inline functions.
  628. */
  629. static void spi_complete(void *arg)
  630. {
  631. complete(arg);
  632. }
  633. /**
  634. * spi_sync - blocking/synchronous SPI data transfers
  635. * @spi: device with which data will be exchanged
  636. * @message: describes the data transfers
  637. * Context: can sleep
  638. *
  639. * This call may only be used from a context that may sleep. The sleep
  640. * is non-interruptible, and has no timeout. Low-overhead controller
  641. * drivers may DMA directly into and out of the message buffers.
  642. *
  643. * Note that the SPI device's chip select is active during the message,
  644. * and then is normally disabled between messages. Drivers for some
  645. * frequently-used devices may want to minimize costs of selecting a chip,
  646. * by leaving it selected in anticipation that the next message will go
  647. * to the same chip. (That may increase power usage.)
  648. *
  649. * Also, the caller is guaranteeing that the memory associated with the
  650. * message will not be freed before this call returns.
  651. *
  652. * It returns zero on success, else a negative error code.
  653. */
  654. int spi_sync(struct spi_device *spi, struct spi_message *message)
  655. {
  656. DECLARE_COMPLETION_ONSTACK(done);
  657. int status;
  658. message->complete = spi_complete;
  659. message->context = &done;
  660. status = spi_async(spi, message);
  661. if (status == 0) {
  662. wait_for_completion(&done);
  663. status = message->status;
  664. }
  665. message->context = NULL;
  666. return status;
  667. }
  668. EXPORT_SYMBOL_GPL(spi_sync);
  669. /* portable code must never pass more than 32 bytes */
  670. #define SPI_BUFSIZ max(32,SMP_CACHE_BYTES)
  671. static u8 *buf;
  672. /**
  673. * spi_write_then_read - SPI synchronous write followed by read
  674. * @spi: device with which data will be exchanged
  675. * @txbuf: data to be written (need not be dma-safe)
  676. * @n_tx: size of txbuf, in bytes
  677. * @rxbuf: buffer into which data will be read (need not be dma-safe)
  678. * @n_rx: size of rxbuf, in bytes
  679. * Context: can sleep
  680. *
  681. * This performs a half duplex MicroWire style transaction with the
  682. * device, sending txbuf and then reading rxbuf. The return value
  683. * is zero for success, else a negative errno status code.
  684. * This call may only be used from a context that may sleep.
  685. *
  686. * Parameters to this routine are always copied using a small buffer;
  687. * portable code should never use this for more than 32 bytes.
  688. * Performance-sensitive or bulk transfer code should instead use
  689. * spi_{async,sync}() calls with dma-safe buffers.
  690. */
  691. int spi_write_then_read(struct spi_device *spi,
  692. const u8 *txbuf, unsigned n_tx,
  693. u8 *rxbuf, unsigned n_rx)
  694. {
  695. static DEFINE_MUTEX(lock);
  696. int status;
  697. struct spi_message message;
  698. struct spi_transfer x[2];
  699. u8 *local_buf;
  700. /* Use preallocated DMA-safe buffer. We can't avoid copying here,
  701. * (as a pure convenience thing), but we can keep heap costs
  702. * out of the hot path ...
  703. */
  704. if ((n_tx + n_rx) > SPI_BUFSIZ)
  705. return -EINVAL;
  706. spi_message_init(&message);
  707. memset(x, 0, sizeof x);
  708. if (n_tx) {
  709. x[0].len = n_tx;
  710. spi_message_add_tail(&x[0], &message);
  711. }
  712. if (n_rx) {
  713. x[1].len = n_rx;
  714. spi_message_add_tail(&x[1], &message);
  715. }
  716. /* ... unless someone else is using the pre-allocated buffer */
  717. if (!mutex_trylock(&lock)) {
  718. local_buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
  719. if (!local_buf)
  720. return -ENOMEM;
  721. } else
  722. local_buf = buf;
  723. memcpy(local_buf, txbuf, n_tx);
  724. x[0].tx_buf = local_buf;
  725. x[1].rx_buf = local_buf + n_tx;
  726. /* do the i/o */
  727. status = spi_sync(spi, &message);
  728. if (status == 0)
  729. memcpy(rxbuf, x[1].rx_buf, n_rx);
  730. if (x[0].tx_buf == buf)
  731. mutex_unlock(&lock);
  732. else
  733. kfree(local_buf);
  734. return status;
  735. }
  736. EXPORT_SYMBOL_GPL(spi_write_then_read);
  737. /*-------------------------------------------------------------------------*/
  738. static int __init spi_init(void)
  739. {
  740. int status;
  741. buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
  742. if (!buf) {
  743. status = -ENOMEM;
  744. goto err0;
  745. }
  746. status = bus_register(&spi_bus_type);
  747. if (status < 0)
  748. goto err1;
  749. status = class_register(&spi_master_class);
  750. if (status < 0)
  751. goto err2;
  752. return 0;
  753. err2:
  754. bus_unregister(&spi_bus_type);
  755. err1:
  756. kfree(buf);
  757. buf = NULL;
  758. err0:
  759. return status;
  760. }
  761. /* board_info is normally registered in arch_initcall(),
  762. * but even essential drivers wait till later
  763. *
  764. * REVISIT only boardinfo really needs static linking. the rest (device and
  765. * driver registration) _could_ be dynamically linked (modular) ... costs
  766. * include needing to have boardinfo data structures be much more public.
  767. */
  768. postcore_initcall(spi_init);