spi.c 26 KB

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