spi.c 23 KB

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