spi.h 38.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * Copyright (C) 2005 David Brownell
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef __LINUX_SPI_H
#define __LINUX_SPI_H

R
Randy Dunlap 已提交
22
#include <linux/device.h>
23
#include <linux/mod_devicetable.h>
24
#include <linux/slab.h>
25
#include <linux/kthread.h>
26
#include <linux/completion.h>
27
#include <linux/scatterlist.h>
R
Randy Dunlap 已提交
28

29
struct dma_chan;
R
Randy Dunlap 已提交
30

31
/*
32
 * INTERFACES between SPI master-side drivers and SPI infrastructure.
33 34 35 36 37 38 39 40 41 42
 * (There's no SPI slave support for Linux yet...)
 */
extern struct bus_type spi_bus_type;

/**
 * struct spi_device - Master side proxy for an SPI slave device
 * @dev: Driver model representation of the device.
 * @master: SPI controller used with the device.
 * @max_speed_hz: Maximum clock rate to be used with this chip
 *	(on this board); may be changed by the device's driver.
43
 *	The spi_transfer.speed_hz can override this for each transfer.
D
David Brownell 已提交
44
 * @chip_select: Chipselect, distinguishing chips handled by @master.
45 46
 * @mode: The spi mode defines how data is clocked out and in.
 *	This may be changed by the device's driver.
D
David Brownell 已提交
47 48 49
 *	The "active low" default for chipselect mode can be overridden
 *	(by specifying SPI_CS_HIGH) as can the "MSB first" default for
 *	each word in a transfer (by specifying SPI_LSB_FIRST).
50
 * @bits_per_word: Data transfers involve one or more words; word sizes
51
 *	like eight or 12 bits are common.  In-memory wordsizes are
52
 *	powers of two bytes (e.g. 20 bit samples use 32 bits).
53 54
 *	This may be changed by the device's driver, or left at the
 *	default (0) indicating protocol words are eight bit bytes.
55
 *	The spi_transfer.bits_per_word can override this for each transfer.
56
 * @irq: Negative, or the number passed to request_irq() to receive
57
 *	interrupts from this device.
58
 * @controller_state: Controller's runtime state
59
 * @controller_data: Board-specific definitions for controller, such as
60
 *	FIFO initialization parameters; from board_info.controller_data
D
David Brownell 已提交
61 62 63
 * @modalias: Name of the driver to use with this device, or an alias
 *	for that name.  This appears in the sysfs "modalias" attribute
 *	for driver coldplugging, and in uevents used for hotplugging
64
 * @cs_gpio: gpio number of the chipselect line (optional, -ENOENT when
65
 *	when not using a GPIO line)
66
 *
D
David Brownell 已提交
67
 * A @spi_device is used to interchange data between an SPI slave
68 69
 * (usually a discrete chip) and CPU memory.
 *
D
David Brownell 已提交
70
 * In @dev, the platform_data is used to hold information about this
71 72
 * device that's meaningful to the device's protocol driver, but not
 * to its controller.  One example might be an identifier for a chip
D
David Brownell 已提交
73 74
 * variant with slightly different functionality; another might be
 * information about how this particular board wires the chip's pins.
75 76 77 78 79 80
 */
struct spi_device {
	struct device		dev;
	struct spi_master	*master;
	u32			max_speed_hz;
	u8			chip_select;
81
	u8			bits_per_word;
W
wangyuhang 已提交
82
	u16			mode;
83 84
#define	SPI_CPHA	0x01			/* clock phase */
#define	SPI_CPOL	0x02			/* clock polarity */
D
David Brownell 已提交
85 86
#define	SPI_MODE_0	(0|0)			/* (original MicroWire) */
#define	SPI_MODE_1	(0|SPI_CPHA)
87 88
#define	SPI_MODE_2	(SPI_CPOL|0)
#define	SPI_MODE_3	(SPI_CPOL|SPI_CPHA)
89
#define	SPI_CS_HIGH	0x04			/* chipselect active high? */
90
#define	SPI_LSB_FIRST	0x08			/* per-word bits-on-wire */
D
David Brownell 已提交
91
#define	SPI_3WIRE	0x10			/* SI/SO signals shared */
A
Anton Vorontsov 已提交
92
#define	SPI_LOOP	0x20			/* loopback mode */
D
David Brownell 已提交
93 94
#define	SPI_NO_CS	0x40			/* 1 dev/bus, no chipselect */
#define	SPI_READY	0x80			/* slave pulls low to pause */
W
wangyuhang 已提交
95 96 97 98
#define	SPI_TX_DUAL	0x100			/* transmit with 2 wires */
#define	SPI_TX_QUAD	0x200			/* transmit with 4 wires */
#define	SPI_RX_DUAL	0x400			/* receive with 2 wires */
#define	SPI_RX_QUAD	0x800			/* receive with 4 wires */
99 100
	int			irq;
	void			*controller_state;
101
	void			*controller_data;
102
	char			modalias[SPI_NAME_SIZE];
103
	int			cs_gpio;	/* chip select gpio */
104

D
David Brownell 已提交
105 106 107 108 109 110 111 112 113
	/*
	 * likely need more hooks for more protocol options affecting how
	 * the controller talks to each chip, like:
	 *  - memory packing (12 bit samples into low bits, others zeroed)
	 *  - priority
	 *  - drop chipselect after each word
	 *  - chipselect delays
	 *  - ...
	 */
114 115 116 117
};

static inline struct spi_device *to_spi_device(struct device *dev)
{
118
	return dev ? container_of(dev, struct spi_device, dev) : NULL;
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
}

/* most drivers won't need to care about device refcounting */
static inline struct spi_device *spi_dev_get(struct spi_device *spi)
{
	return (spi && get_device(&spi->dev)) ? spi : NULL;
}

static inline void spi_dev_put(struct spi_device *spi)
{
	if (spi)
		put_device(&spi->dev);
}

/* ctldata is for the bus_master driver's runtime state */
static inline void *spi_get_ctldata(struct spi_device *spi)
{
	return spi->controller_state;
}

static inline void spi_set_ctldata(struct spi_device *spi, void *state)
{
	spi->controller_state = state;
}

144 145 146 147 148 149 150 151 152 153 154
/* device driver data */

static inline void spi_set_drvdata(struct spi_device *spi, void *data)
{
	dev_set_drvdata(&spi->dev, data);
}

static inline void *spi_get_drvdata(struct spi_device *spi)
{
	return dev_get_drvdata(&spi->dev);
}
155 156

struct spi_message;
157
struct spi_transfer;
158

D
David Brownell 已提交
159 160
/**
 * struct spi_driver - Host side "protocol" driver
161
 * @id_table: List of SPI devices supported by this driver
D
David Brownell 已提交
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
 * @probe: Binds this driver to the spi device.  Drivers can verify
 *	that the device is actually present, and may need to configure
 *	characteristics (such as bits_per_word) which weren't needed for
 *	the initial configuration done during system setup.
 * @remove: Unbinds this driver from the spi device
 * @shutdown: Standard shutdown callback used during system state
 *	transitions such as powerdown/halt and kexec
 * @suspend: Standard suspend callback used during system state transitions
 * @resume: Standard resume callback used during system state transitions
 * @driver: SPI device drivers should initialize the name and owner
 *	field of this structure.
 *
 * This represents the kind of device driver that uses SPI messages to
 * interact with the hardware at the other end of a SPI link.  It's called
 * a "protocol" driver because it works through messages rather than talking
 * directly to SPI hardware (which is what the underlying SPI controller
 * driver does to pass those messages).  These protocols are defined in the
 * specification for the device(s) supported by the driver.
 *
 * As a rule, those device protocols represent the lowest level interface
 * supported by a driver, and it will support upper level interfaces too.
 * Examples of such upper levels include frameworks like MTD, networking,
 * MMC, RTC, filesystem character device nodes, and hardware monitoring.
 */
186
struct spi_driver {
187
	const struct spi_device_id *id_table;
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
	int			(*probe)(struct spi_device *spi);
	int			(*remove)(struct spi_device *spi);
	void			(*shutdown)(struct spi_device *spi);
	int			(*suspend)(struct spi_device *spi, pm_message_t mesg);
	int			(*resume)(struct spi_device *spi);
	struct device_driver	driver;
};

static inline struct spi_driver *to_spi_driver(struct device_driver *drv)
{
	return drv ? container_of(drv, struct spi_driver, driver) : NULL;
}

extern int spi_register_driver(struct spi_driver *sdrv);

D
David Brownell 已提交
203 204 205 206 207
/**
 * spi_unregister_driver - reverse effect of spi_register_driver
 * @sdrv: the driver to unregister
 * Context: can sleep
 */
208 209
static inline void spi_unregister_driver(struct spi_driver *sdrv)
{
210 211
	if (sdrv)
		driver_unregister(&sdrv->driver);
212 213
}

214 215 216 217 218 219 220 221 222 223 224
/**
 * module_spi_driver() - Helper macro for registering a SPI driver
 * @__spi_driver: spi_driver struct
 *
 * Helper macro for SPI drivers which do not do anything special in module
 * init/exit. This eliminates a lot of boilerplate. Each module may only
 * use this macro once, and calling it replaces module_init() and module_exit()
 */
#define module_spi_driver(__spi_driver) \
	module_driver(__spi_driver, spi_register_driver, \
			spi_unregister_driver)
225

226 227
/**
 * struct spi_master - interface to SPI master controller
T
Tony Jones 已提交
228
 * @dev: device interface to this driver
229
 * @list: link with the global spi_master list
230
 * @bus_num: board-specific (and often SOC-specific) identifier for a
231
 *	given SPI controller.
232
 * @num_chipselect: chipselects are used to distinguish individual
233 234 235
 *	SPI slaves, and are numbered from zero to num_chipselects.
 *	each slave has a chipselect signal, but it's common that not
 *	every chipselect is connected to a slave.
236
 * @dma_alignment: SPI controller constraint on DMA buffers alignment.
237
 * @mode_bits: flags understood by this controller driver
238 239
 * @bits_per_word_mask: A mask indicating which values of bits_per_word are
 *	supported by the driver. Bit n indicates that a bits_per_word n+1 is
240
 *	supported. If set, the SPI core will reject any transfer with an
241 242
 *	unsupported bits_per_word. If not set, this value is simply ignored,
 *	and it's up to the individual driver to perform any validation.
243 244
 * @min_speed_hz: Lowest supported transfer speed
 * @max_speed_hz: Highest supported transfer speed
245
 * @flags: other constraints relevant to this driver
246 247 248
 * @bus_lock_spinlock: spinlock for SPI bus locking
 * @bus_lock_mutex: mutex for SPI bus locking
 * @bus_lock_flag: indicates that the SPI bus is locked for exclusive use
249
 * @setup: updates the device mode and clocking records used by a
D
David Brownell 已提交
250 251
 *	device's SPI controller; protocol code may call this.  This
 *	must fail if an unrecognized or unsupported mode is requested.
D
David Brownell 已提交
252 253
 *	It's always safe to call this unless transfers are pending on
 *	the device whose settings are being modified.
254 255
 * @transfer: adds a message to the controller's transfer queue.
 * @cleanup: frees controller-specific state
T
Thierry Reding 已提交
256
 * @can_dma: determine whether this master supports DMA
257 258 259 260 261 262 263
 * @queued: whether this master is providing an internal message queue
 * @kworker: thread struct for message pump
 * @kworker_task: pointer to task for message pump kworker thread
 * @pump_messages: work struct for scheduling work to the message pump
 * @queue_lock: spinlock to syncronise access to message queue
 * @queue: message queue
 * @cur_msg: the currently in-flight message
264 265
 * @cur_msg_prepared: spi_prepare_message was called for the currently
 *                    in-flight message
T
Thierry Reding 已提交
266
 * @cur_msg_mapped: message has been mapped for DMA
267
 * @xfer_completion: used by core transfer_one_message()
268 269 270
 * @busy: message pump is busy
 * @running: message pump is running
 * @rt: whether this queue is set to run as a realtime task
271 272 273
 * @auto_runtime_pm: the core should ensure a runtime PM reference is held
 *                   while the hardware is prepared, using the parent
 *                   device for the spidev
274
 * @max_dma_len: Maximum length of a DMA transfer for the device.
275 276 277 278 279 280 281
 * @prepare_transfer_hardware: a message will soon arrive from the queue
 *	so the subsystem requests the driver to prepare the transfer hardware
 *	by issuing this call
 * @transfer_one_message: the subsystem calls the driver to transfer a single
 *	message while queuing transfers that arrive in the meantime. When the
 *	driver is finished with this message, it must call
 *	spi_finalize_current_message() so the subsystem can issue the next
282
 *	message
R
Randy Dunlap 已提交
283
 * @unprepare_transfer_hardware: there are currently no more messages on the
284 285
 *	queue so the subsystem notifies the driver that it may relax the
 *	hardware by issuing this call
286
 * @set_cs: set the logic level of the chip select line.  May be called
287
 *          from interrupt context.
288 289 290
 * @prepare_message: set up the controller to transfer a single message,
 *                   for example doing DMA mapping.  Called from threaded
 *                   context.
291 292 293 294 295
 * @transfer_one: transfer a single spi_transfer.
 *                  - return 0 if the transfer is finished,
 *                  - return 1 if the transfer is still in progress. When
 *                    the driver is finished with this transfer it must
 *                    call spi_finalize_current_transfer() so the subsystem
296 297 298 299
 *                    can issue the next transfer. Note: transfer_one and
 *                    transfer_one_message are mutually exclusive; when both
 *                    are set, the generic subsystem does not call your
 *                    transfer_one callback.
300
 * @unprepare_message: undo any work done by prepare_message().
301
 * @cs_gpios: Array of GPIOs to use as chip select lines; one per CS
302
 *	number. Any individual value may be -ENOENT for CS lines that
303
 *	are not GPIOs (driven by the SPI controller itself).
T
Thierry Reding 已提交
304 305 306 307
 * @dma_tx: DMA transmit channel
 * @dma_rx: DMA receive channel
 * @dummy_rx: dummy receive buffer for full-duplex devices
 * @dummy_tx: dummy transmit buffer for full-duplex devices
308
 *
D
David Brownell 已提交
309
 * Each SPI master controller can communicate with one or more @spi_device
310 311 312 313 314 315
 * children.  These make a small bus, sharing MOSI, MISO and SCK signals
 * but not chip select signals.  Each device may be configured to use a
 * different clock rate, since those shared signals are ignored unless
 * the chip is selected.
 *
 * The driver for an SPI controller manages access to those devices through
D
David Brownell 已提交
316 317
 * a queue of spi_message transactions, copying data between CPU memory and
 * an SPI slave device.  For each such message it queues, it calls the
318 319 320
 * message's completion function when the transaction completes.
 */
struct spi_master {
T
Tony Jones 已提交
321
	struct device	dev;
322

323 324
	struct list_head list;

325
	/* other than negative (== assign one dynamically), bus_num is fully
326
	 * board-specific.  usually that simplifies to being SOC-specific.
327
	 * example:  one SOC has three SPI controllers, numbered 0..2,
328 329 330
	 * and one board's schematics might show it using SPI-2.  software
	 * would normally use bus_num=2 for that controller.
	 */
331
	s16			bus_num;
332 333 334 335 336 337

	/* chipselects will be integral to many controllers; some others
	 * might use board-specific GPIOs.
	 */
	u16			num_chipselect;

338 339 340 341 342
	/* some SPI controllers pose alignment requirements on DMAable
	 * buffers; let protocol drivers know about these requirements.
	 */
	u16			dma_alignment;

343 344 345
	/* spi_device.mode flags understood by this controller driver */
	u16			mode_bits;

346 347
	/* bitmask of supported bits_per_word for transfers */
	u32			bits_per_word_mask;
348
#define SPI_BPW_MASK(bits) BIT((bits) - 1)
349
#define SPI_BIT_MASK(bits) (((bits) == 32) ? ~0U : (BIT(bits) - 1))
350
#define SPI_BPW_RANGE_MASK(min, max) (SPI_BIT_MASK(max) - SPI_BIT_MASK(min - 1))
351

352 353 354 355
	/* limits on transfer speed */
	u32			min_speed_hz;
	u32			max_speed_hz;

D
David Brownell 已提交
356 357 358
	/* other constraints relevant to this driver */
	u16			flags;
#define SPI_MASTER_HALF_DUPLEX	BIT(0)		/* can't do full duplex */
D
David Brownell 已提交
359 360
#define SPI_MASTER_NO_RX	BIT(1)		/* can't do buffer read */
#define SPI_MASTER_NO_TX	BIT(2)		/* can't do buffer write */
361 362
#define SPI_MASTER_MUST_RX      BIT(3)		/* requires rx */
#define SPI_MASTER_MUST_TX      BIT(4)		/* requires tx */
D
David Brownell 已提交
363

364 365 366 367 368 369 370
	/* lock and mutex for SPI bus locking */
	spinlock_t		bus_lock_spinlock;
	struct mutex		bus_lock_mutex;

	/* flag indicating that the SPI bus is locked for exclusive use */
	bool			bus_lock_flag;

371 372 373 374 375 376
	/* Setup mode and clock, etc (spi driver may call many times).
	 *
	 * IMPORTANT:  this may be called when transfers to another
	 * device are active.  DO NOT UPDATE SHARED REGISTERS in ways
	 * which could break those transfers.
	 */
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
	int			(*setup)(struct spi_device *spi);

	/* bidirectional bulk transfers
	 *
	 * + The transfer() method may not sleep; its main role is
	 *   just to add the message to the queue.
	 * + For now there's no remove-from-queue operation, or
	 *   any other request management
	 * + To a given spi_device, message queueing is pure fifo
	 *
	 * + The master's main job is to process its message queue,
	 *   selecting a chip then transferring data
	 * + If there are multiple spi_device children, the i/o queue
	 *   arbitration algorithm is unspecified (round robin, fifo,
	 *   priority, reservations, preemption, etc)
	 *
	 * + Chipselect stays active during the entire message
	 *   (unless modified by spi_transfer.cs_change != 0).
	 * + The message transfers use clock and SPI mode parameters
	 *   previously established by setup() for this device
	 */
	int			(*transfer)(struct spi_device *spi,
						struct spi_message *mesg);

	/* called on release() to free memory provided by spi_master */
402
	void			(*cleanup)(struct spi_device *spi);
403

404 405 406 407 408 409 410 411 412 413 414
	/*
	 * Used to enable core support for DMA handling, if can_dma()
	 * exists and returns true then the transfer will be mapped
	 * prior to transfer_one() being called.  The driver should
	 * not modify or store xfer and dma_tx and dma_rx must be set
	 * while the device is prepared.
	 */
	bool			(*can_dma)(struct spi_master *master,
					   struct spi_device *spi,
					   struct spi_transfer *xfer);

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
	/*
	 * These hooks are for drivers that want to use the generic
	 * master transfer queueing mechanism. If these are used, the
	 * transfer() function above must NOT be specified by the driver.
	 * Over time we expect SPI drivers to be phased over to this API.
	 */
	bool				queued;
	struct kthread_worker		kworker;
	struct task_struct		*kworker_task;
	struct kthread_work		pump_messages;
	spinlock_t			queue_lock;
	struct list_head		queue;
	struct spi_message		*cur_msg;
	bool				busy;
	bool				running;
	bool				rt;
431
	bool				auto_runtime_pm;
432
	bool                            cur_msg_prepared;
433
	bool				cur_msg_mapped;
434
	struct completion               xfer_completion;
435
	size_t				max_dma_len;
436 437 438 439 440

	int (*prepare_transfer_hardware)(struct spi_master *master);
	int (*transfer_one_message)(struct spi_master *master,
				    struct spi_message *mesg);
	int (*unprepare_transfer_hardware)(struct spi_master *master);
441 442 443 444
	int (*prepare_message)(struct spi_master *master,
			       struct spi_message *message);
	int (*unprepare_message)(struct spi_master *master,
				 struct spi_message *message);
445

446 447 448 449 450 451 452 453
	/*
	 * These hooks are for drivers that use a generic implementation
	 * of transfer_one_message() provied by the core.
	 */
	void (*set_cs)(struct spi_device *spi, bool enable);
	int (*transfer_one)(struct spi_master *master, struct spi_device *spi,
			    struct spi_transfer *transfer);

454 455
	/* gpio chip select */
	int			*cs_gpios;
456 457 458 459

	/* DMA channels for use with core dmaengine helpers */
	struct dma_chan		*dma_tx;
	struct dma_chan		*dma_rx;
460 461 462 463

	/* dummy data for full duplex devices */
	void			*dummy_rx;
	void			*dummy_tx;
464 465
};

D
David Brownell 已提交
466 467
static inline void *spi_master_get_devdata(struct spi_master *master)
{
T
Tony Jones 已提交
468
	return dev_get_drvdata(&master->dev);
D
David Brownell 已提交
469 470 471 472
}

static inline void spi_master_set_devdata(struct spi_master *master, void *data)
{
T
Tony Jones 已提交
473
	dev_set_drvdata(&master->dev, data);
D
David Brownell 已提交
474 475 476 477
}

static inline struct spi_master *spi_master_get(struct spi_master *master)
{
T
Tony Jones 已提交
478
	if (!master || !get_device(&master->dev))
D
David Brownell 已提交
479 480 481 482 483 484 485
		return NULL;
	return master;
}

static inline void spi_master_put(struct spi_master *master)
{
	if (master)
T
Tony Jones 已提交
486
		put_device(&master->dev);
D
David Brownell 已提交
487 488
}

489 490 491 492 493 494 495
/* PM calls that need to be issued by the driver */
extern int spi_master_suspend(struct spi_master *master);
extern int spi_master_resume(struct spi_master *master);

/* Calls the driver make to interact with the message queue */
extern struct spi_message *spi_get_next_queued_message(struct spi_master *master);
extern void spi_finalize_current_message(struct spi_master *master);
496
extern void spi_finalize_current_transfer(struct spi_master *master);
D
David Brownell 已提交
497

498 499 500 501 502
/* the spi driver core manages memory for the spi_master classdev */
extern struct spi_master *
spi_alloc_master(struct device *host, unsigned size);

extern int spi_register_master(struct spi_master *master);
503 504
extern int devm_spi_register_master(struct device *dev,
				    struct spi_master *master);
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
extern void spi_unregister_master(struct spi_master *master);

extern struct spi_master *spi_busnum_to_master(u16 busnum);

/*---------------------------------------------------------------------------*/

/*
 * I/O INTERFACE between SPI controller and protocol drivers
 *
 * Protocol drivers use a queue of spi_messages, each transferring data
 * between the controller and memory buffers.
 *
 * The spi_messages themselves consist of a series of read+write transfer
 * segments.  Those segments always read the same number of bits as they
 * write; but one or the other is easily ignored by passing a null buffer
 * pointer.  (This is unlike most types of I/O API, because SPI hardware
 * is full duplex.)
 *
 * NOTE:  Allocation of spi_transfer and spi_message memory is entirely
 * up to the protocol driver, which guarantees the integrity of both (as
 * well as the data buffers) for as long as the message is queued.
 */

/**
 * struct spi_transfer - a read/write buffer pair
530 531
 * @tx_buf: data to be written (dma-safe memory), or NULL
 * @rx_buf: data to be read (dma-safe memory), or NULL
D
David Brownell 已提交
532 533
 * @tx_dma: DMA address of tx_buf, if @spi_message.is_dma_mapped
 * @rx_dma: DMA address of rx_buf, if @spi_message.is_dma_mapped
534
 * @tx_nbits: number of bits used for writing. If 0 the default
W
wangyuhang 已提交
535 536 537
 *      (SPI_NBITS_SINGLE) is used.
 * @rx_nbits: number of bits used for reading. If 0 the default
 *      (SPI_NBITS_SINGLE) is used.
538
 * @len: size of rx and tx buffers (in bytes)
539
 * @speed_hz: Select a speed other than the device default for this
D
David Brownell 已提交
540
 *      transfer. If 0 the default (from @spi_device) is used.
541
 * @bits_per_word: select a bits_per_word other than the device default
D
David Brownell 已提交
542
 *      for this transfer. If 0 the default (from @spi_device) is used.
543 544
 * @cs_change: affects chipselect after this transfer completes
 * @delay_usecs: microseconds to delay after this transfer before
545
 *	(optionally) changing the chipselect status, then starting
D
David Brownell 已提交
546 547
 *	the next transfer or completing this @spi_message.
 * @transfer_list: transfers are sequenced through @spi_message.transfers
548 549
 * @tx_sg: Scatterlist for transmit, currently not for client use
 * @rx_sg: Scatterlist for receive, currently not for client use
550 551
 *
 * SPI transfers always write the same number of bytes as they read.
D
David Brownell 已提交
552
 * Protocol drivers should always provide @rx_buf and/or @tx_buf.
553 554 555 556
 * In some cases, they may also want to provide DMA addresses for
 * the data being transferred; that may reduce overhead, when the
 * underlying driver uses dma.
 *
557
 * If the transmit buffer is null, zeroes will be shifted out
D
David Brownell 已提交
558
 * while filling @rx_buf.  If the receive buffer is null, the data
559 560 561 562 563
 * shifted in will be discarded.  Only "len" bytes shift out (or in).
 * It's an error to try to shift out a partial word.  (For example, by
 * shifting out three bytes with word size of sixteen or twenty bits;
 * the former uses two bytes per word, the latter uses four bytes.)
 *
D
David Brownell 已提交
564 565 566
 * In-memory data values are always in native CPU byte order, translated
 * from the wire byte order (big-endian except with SPI_LSB_FIRST).  So
 * for example when bits_per_word is sixteen, buffers are 2N bytes long
D
David Brownell 已提交
567
 * (@len = 2N) and hold N sixteen bit words in CPU byte order.
D
David Brownell 已提交
568 569 570 571 572 573
 *
 * When the word size of the SPI transfer is not a power-of-two multiple
 * of eight bits, those in-memory words include extra bits.  In-memory
 * words are always seen by protocol drivers as right-justified, so the
 * undefined (rx) or unused (tx) bits are always the most significant bits.
 *
574 575
 * All SPI transfers start with the relevant chipselect active.  Normally
 * it stays selected until after the last transfer in a message.  Drivers
D
David Brownell 已提交
576
 * can affect the chipselect signal using cs_change.
577 578 579 580 581 582 583 584
 *
 * (i) If the transfer isn't the last one in the message, this flag is
 * used to make the chipselect briefly go inactive in the middle of the
 * message.  Toggling chipselect in this way may be needed to terminate
 * a chip command, letting a single spi_message perform all of group of
 * chip transactions together.
 *
 * (ii) When the transfer is the last one in the message, the chip may
D
David Brownell 已提交
585 586 587 588 589 590 591 592
 * stay selected until the next transfer.  On multi-device SPI busses
 * with nothing blocking messages going to other devices, this is just
 * a performance hint; starting a message to another device deselects
 * this one.  But in other cases, this can be used to ensure correctness.
 * Some devices need protocol transactions to be built from a series of
 * spi_message submissions, where the content of one message is determined
 * by the results of previous messages and where the whole transaction
 * ends when the chipselect goes intactive.
D
David Brownell 已提交
593
 *
594
 * When SPI can transfer in 1x,2x or 4x. It can get this transfer information
W
wangyuhang 已提交
595 596 597 598
 * from device through @tx_nbits and @rx_nbits. In Bi-direction, these
 * two should both be set. User can set transfer mode with SPI_NBITS_SINGLE(1x)
 * SPI_NBITS_DUAL(2x) and SPI_NBITS_QUAD(4x) to support these three transfer.
 *
D
David Brownell 已提交
599 600 601
 * The code that submits an spi_message (and its spi_transfers)
 * to the lower layers is responsible for managing its memory.
 * Zero-initialize every field you don't set up explicitly, to
602 603
 * insulate against future API updates.  After you submit a message
 * and its transfers, ignore them until its completion callback.
604 605 606 607
 */
struct spi_transfer {
	/* it's ok if tx_buf == rx_buf (right?)
	 * for MicroWire, one buffer must be null
D
David Brownell 已提交
608 609
	 * buffers must work with dma_*map_single() calls, unless
	 *   spi_message.is_dma_mapped reports a pre-existing mapping
610 611 612 613 614 615 616
	 */
	const void	*tx_buf;
	void		*rx_buf;
	unsigned	len;

	dma_addr_t	tx_dma;
	dma_addr_t	rx_dma;
617 618
	struct sg_table tx_sg;
	struct sg_table rx_sg;
619 620

	unsigned	cs_change:1;
621 622
	unsigned	tx_nbits:3;
	unsigned	rx_nbits:3;
W
wangyuhang 已提交
623 624 625
#define	SPI_NBITS_SINGLE	0x01 /* 1bit transfer */
#define	SPI_NBITS_DUAL		0x02 /* 2bits transfer */
#define	SPI_NBITS_QUAD		0x04 /* 4bits transfer */
626
	u8		bits_per_word;
627
	u16		delay_usecs;
628
	u32		speed_hz;
629 630

	struct list_head transfer_list;
631 632 633 634
};

/**
 * struct spi_message - one multi-segment SPI transaction
635
 * @transfers: list of transfer segments in this transaction
636 637 638 639 640
 * @spi: SPI device to which the transaction is queued
 * @is_dma_mapped: if true, the caller provided both dma and cpu virtual
 *	addresses for each transfer buffer
 * @complete: called to report transaction completions
 * @context: the argument to complete() when it's called
T
Thierry Reding 已提交
641
 * @frame_length: the total number of bytes in the message
642 643
 * @actual_length: the total number of bytes that were transferred in all
 *	successful segments
644 645 646
 * @status: zero for success, else negative errno
 * @queue: for use by whichever driver currently owns the message
 * @state: for use by whichever driver currently owns the message
D
David Brownell 已提交
647
 *
D
David Brownell 已提交
648
 * A @spi_message is used to execute an atomic sequence of data transfers,
649 650 651 652 653 654 655
 * each represented by a struct spi_transfer.  The sequence is "atomic"
 * in the sense that no other spi_message may use that SPI bus until that
 * sequence completes.  On some systems, many such sequences can execute as
 * as single programmed DMA transfer.  On all systems, these messages are
 * queued, and might complete after transactions to other devices.  Messages
 * sent to a given spi_device are alway executed in FIFO order.
 *
D
David Brownell 已提交
656 657 658
 * The code that submits an spi_message (and its spi_transfers)
 * to the lower layers is responsible for managing its memory.
 * Zero-initialize every field you don't set up explicitly, to
659 660
 * insulate against future API updates.  After you submit a message
 * and its transfers, ignore them until its completion callback.
661 662
 */
struct spi_message {
663
	struct list_head	transfers;
664 665 666 667 668 669 670 671 672 673 674 675

	struct spi_device	*spi;

	unsigned		is_dma_mapped:1;

	/* REVISIT:  we might want a flag affecting the behavior of the
	 * last transfer ... allowing things like "read 16 bit length L"
	 * immediately followed by "read L bytes".  Basically imposing
	 * a specific message scheduling algorithm.
	 *
	 * Some controller drivers (message-at-a-time queue processing)
	 * could provide that as their default scheduling algorithm.  But
676
	 * others (with multi-message pipelines) could need a flag to
677 678 679 680
	 * tell them about such special cases.
	 */

	/* completion is reported through a callback */
681
	void			(*complete)(void *context);
682
	void			*context;
683
	unsigned		frame_length;
684 685 686 687 688 689 690 691 692 693 694
	unsigned		actual_length;
	int			status;

	/* for optional use by whatever driver currently owns the
	 * spi_message ...  between calls to spi_async and then later
	 * complete(), that's the spi_master controller driver.
	 */
	struct list_head	queue;
	void			*state;
};

695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
static inline void spi_message_init(struct spi_message *m)
{
	memset(m, 0, sizeof *m);
	INIT_LIST_HEAD(&m->transfers);
}

static inline void
spi_message_add_tail(struct spi_transfer *t, struct spi_message *m)
{
	list_add_tail(&t->transfer_list, &m->transfers);
}

static inline void
spi_transfer_del(struct spi_transfer *t)
{
	list_del(&t->transfer_list);
}

713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
/**
 * spi_message_init_with_transfers - Initialize spi_message and append transfers
 * @m: spi_message to be initialized
 * @xfers: An array of spi transfers
 * @num_xfers: Number of items in the xfer array
 *
 * This function initializes the given spi_message and adds each spi_transfer in
 * the given array to the message.
 */
static inline void
spi_message_init_with_transfers(struct spi_message *m,
struct spi_transfer *xfers, unsigned int num_xfers)
{
	unsigned int i;

	spi_message_init(m);
	for (i = 0; i < num_xfers; ++i)
		spi_message_add_tail(&xfers[i], m);
}

D
David Brownell 已提交
733 734 735 736 737 738 739 740 741 742 743 744
/* It's fine to embed message and transaction structures in other data
 * structures so long as you don't free them while they're in use.
 */

static inline struct spi_message *spi_message_alloc(unsigned ntrans, gfp_t flags)
{
	struct spi_message *m;

	m = kzalloc(sizeof(struct spi_message)
			+ ntrans * sizeof(struct spi_transfer),
			flags);
	if (m) {
S
Shubhrajyoti D 已提交
745
		unsigned i;
746 747 748 749 750
		struct spi_transfer *t = (struct spi_transfer *)(m + 1);

		INIT_LIST_HEAD(&m->transfers);
		for (i = 0; i < ntrans; i++, t++)
			spi_message_add_tail(t, m);
D
David Brownell 已提交
751 752 753 754 755 756 757 758 759
	}
	return m;
}

static inline void spi_message_free(struct spi_message *m)
{
	kfree(m);
}

760
extern int spi_setup(struct spi_device *spi);
D
David Brownell 已提交
761
extern int spi_async(struct spi_device *spi, struct spi_message *message);
762 763
extern int spi_async_locked(struct spi_device *spi,
			    struct spi_message *message);
764 765 766 767 768 769 770 771 772

/*---------------------------------------------------------------------------*/

/* All these synchronous SPI transfer routines are utilities layered
 * over the core async transfer primitive.  Here, "synchronous" means
 * they will sleep uninterruptibly until the async transfer completes.
 */

extern int spi_sync(struct spi_device *spi, struct spi_message *message);
773 774 775
extern int spi_sync_locked(struct spi_device *spi, struct spi_message *message);
extern int spi_bus_lock(struct spi_master *master);
extern int spi_bus_unlock(struct spi_master *master);
776 777 778 779 780 781

/**
 * spi_write - SPI synchronous write
 * @spi: device to which data will be written
 * @buf: data buffer
 * @len: data buffer size
D
David Brownell 已提交
782
 * Context: can sleep
783 784 785 786 787
 *
 * This writes the buffer and returns zero or a negative error code.
 * Callable only from contexts that can sleep.
 */
static inline int
788
spi_write(struct spi_device *spi, const void *buf, size_t len)
789 790 791 792 793
{
	struct spi_transfer	t = {
			.tx_buf		= buf,
			.len		= len,
		};
794
	struct spi_message	m;
795

796 797
	spi_message_init(&m);
	spi_message_add_tail(&t, &m);
798 799 800 801 802 803 804 805
	return spi_sync(spi, &m);
}

/**
 * spi_read - SPI synchronous read
 * @spi: device from which data will be read
 * @buf: data buffer
 * @len: data buffer size
D
David Brownell 已提交
806
 * Context: can sleep
807
 *
D
David Brownell 已提交
808
 * This reads the buffer and returns zero or a negative error code.
809 810 811
 * Callable only from contexts that can sleep.
 */
static inline int
812
spi_read(struct spi_device *spi, void *buf, size_t len)
813 814 815 816 817
{
	struct spi_transfer	t = {
			.rx_buf		= buf,
			.len		= len,
		};
818
	struct spi_message	m;
819

820 821
	spi_message_init(&m);
	spi_message_add_tail(&t, &m);
822 823 824
	return spi_sync(spi, &m);
}

825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
/**
 * spi_sync_transfer - synchronous SPI data transfer
 * @spi: device with which data will be exchanged
 * @xfers: An array of spi_transfers
 * @num_xfers: Number of items in the xfer array
 * Context: can sleep
 *
 * Does a synchronous SPI data transfer of the given spi_transfer array.
 *
 * For more specific semantics see spi_sync().
 *
 * It returns zero on success, else a negative error code.
 */
static inline int
spi_sync_transfer(struct spi_device *spi, struct spi_transfer *xfers,
	unsigned int num_xfers)
{
	struct spi_message msg;

	spi_message_init_with_transfers(&msg, xfers, num_xfers);

	return spi_sync(spi, &msg);
}

D
David Brownell 已提交
849
/* this copies txbuf and rxbuf data; for small transfers only! */
850
extern int spi_write_then_read(struct spi_device *spi,
851 852
		const void *txbuf, unsigned n_tx,
		void *rxbuf, unsigned n_rx);
853 854 855 856 857

/**
 * spi_w8r8 - SPI synchronous 8 bit write followed by 8 bit read
 * @spi: device with which data will be exchanged
 * @cmd: command to be written before data is read back
D
David Brownell 已提交
858
 * Context: can sleep
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
 *
 * This returns the (unsigned) eight bit number returned by the
 * device, or else a negative error code.  Callable only from
 * contexts that can sleep.
 */
static inline ssize_t spi_w8r8(struct spi_device *spi, u8 cmd)
{
	ssize_t			status;
	u8			result;

	status = spi_write_then_read(spi, &cmd, 1, &result, 1);

	/* return negative errno or unsigned value */
	return (status < 0) ? status : result;
}

/**
 * spi_w8r16 - SPI synchronous 8 bit write followed by 16 bit read
 * @spi: device with which data will be exchanged
 * @cmd: command to be written before data is read back
D
David Brownell 已提交
879
 * Context: can sleep
880 881 882 883 884 885 886 887 888 889 890 891 892
 *
 * This returns the (unsigned) sixteen bit number returned by the
 * device, or else a negative error code.  Callable only from
 * contexts that can sleep.
 *
 * The number is returned in wire-order, which is at least sometimes
 * big-endian.
 */
static inline ssize_t spi_w8r16(struct spi_device *spi, u8 cmd)
{
	ssize_t			status;
	u16			result;

893
	status = spi_write_then_read(spi, &cmd, 1, &result, 2);
894 895 896 897 898

	/* return negative errno or unsigned value */
	return (status < 0) ? status : result;
}

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
/**
 * spi_w8r16be - SPI synchronous 8 bit write followed by 16 bit big-endian read
 * @spi: device with which data will be exchanged
 * @cmd: command to be written before data is read back
 * Context: can sleep
 *
 * This returns the (unsigned) sixteen bit number returned by the device in cpu
 * endianness, or else a negative error code. Callable only from contexts that
 * can sleep.
 *
 * This function is similar to spi_w8r16, with the exception that it will
 * convert the read 16 bit data word from big-endian to native endianness.
 *
 */
static inline ssize_t spi_w8r16be(struct spi_device *spi, u8 cmd)

{
	ssize_t status;
	__be16 result;

	status = spi_write_then_read(spi, &cmd, 1, &result, 2);
	if (status < 0)
		return status;

	return be16_to_cpu(result);
}

926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
/*---------------------------------------------------------------------------*/

/*
 * INTERFACE between board init code and SPI infrastructure.
 *
 * No SPI driver ever sees these SPI device table segments, but
 * it's how the SPI core (or adapters that get hotplugged) grows
 * the driver model tree.
 *
 * As a rule, SPI devices can't be probed.  Instead, board init code
 * provides a table listing the devices which are present, with enough
 * information to bind and set up the device's driver.  There's basic
 * support for nonstatic configurations too; enough to handle adding
 * parport adapters, or microcontrollers acting as USB-to-SPI bridges.
 */

D
David Brownell 已提交
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
/**
 * struct spi_board_info - board-specific template for a SPI device
 * @modalias: Initializes spi_device.modalias; identifies the driver.
 * @platform_data: Initializes spi_device.platform_data; the particular
 *	data stored there is driver-specific.
 * @controller_data: Initializes spi_device.controller_data; some
 *	controllers need hints about hardware setup, e.g. for DMA.
 * @irq: Initializes spi_device.irq; depends on how the board is wired.
 * @max_speed_hz: Initializes spi_device.max_speed_hz; based on limits
 *	from the chip datasheet and board-specific signal quality issues.
 * @bus_num: Identifies which spi_master parents the spi_device; unused
 *	by spi_new_device(), and otherwise depends on board wiring.
 * @chip_select: Initializes spi_device.chip_select; depends on how
 *	the board is wired.
 * @mode: Initializes spi_device.mode; based on the chip datasheet, board
 *	wiring (some devices support both 3WIRE and standard modes), and
 *	possibly presence of an inverter in the chipselect path.
 *
 * When adding new SPI devices to the device tree, these structures serve
 * as a partial device template.  They hold information which can't always
 * be determined by drivers.  Information that probe() can establish (such
 * as the default transfer wordsize) is not included here.
 *
 * These structures are used in two places.  Their primary role is to
 * be stored in tables of board-specific device descriptors, which are
 * declared early in board initialization and then used (much later) to
 * populate a controller's device tree after the that controller's driver
 * initializes.  A secondary (and atypical) role is as a parameter to
 * spi_new_device() call, which happens after those controller drivers
 * are active in some dynamic board configuration models.
 */
973 974 975 976 977
struct spi_board_info {
	/* the device name and module name are coupled, like platform_bus;
	 * "modalias" is normally the driver name.
	 *
	 * platform_data goes to spi_device.dev.platform_data,
978
	 * controller_data goes to spi_device.controller_data,
979 980
	 * irq is copied too
	 */
981
	char		modalias[SPI_NAME_SIZE];
982
	const void	*platform_data;
983
	void		*controller_data;
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
	int		irq;

	/* slower signaling on noisy or low voltage boards */
	u32		max_speed_hz;


	/* bus_num is board specific and matches the bus_num of some
	 * spi_master that will probably be registered later.
	 *
	 * chip_select reflects how this chip is wired to that master;
	 * it's less than num_chipselect.
	 */
	u16		bus_num;
	u16		chip_select;

999 1000 1001
	/* mode becomes spi_device.mode, and is essential for chips
	 * where the default of SPI_CS_HIGH = 0 is wrong.
	 */
W
wangyuhang 已提交
1002
	u16		mode;
1003

1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
	/* ... may need additional spi_device chip config data here.
	 * avoid stuff protocol drivers can set; but include stuff
	 * needed to behave without being bound to a driver:
	 *  - quirks like clock rate mattering when not selected
	 */
};

#ifdef	CONFIG_SPI
extern int
spi_register_board_info(struct spi_board_info const *info, unsigned n);
#else
/* board init code may ignore whether SPI is configured or not */
static inline int
spi_register_board_info(struct spi_board_info const *info, unsigned n)
	{ return 0; }
#endif


/* If you're hotplugging an adapter with devices (parport, usb, etc)
D
David Brownell 已提交
1023 1024 1025
 * use spi_new_device() to describe each device.  You can also call
 * spi_unregister_device() to start making that device vanish, but
 * normally that would be handled by spi_unregister_master().
1026 1027 1028 1029 1030 1031
 *
 * You can also use spi_alloc_device() and spi_add_device() to use a two
 * stage registration sequence for each spi_device.  This gives the caller
 * some more control over the spi_device structure before it is registered,
 * but requires that caller to initialize fields that would otherwise
 * be defined using the board info.
1032
 */
1033 1034 1035 1036 1037 1038
extern struct spi_device *
spi_alloc_device(struct spi_master *master);

extern int
spi_add_device(struct spi_device *spi);

1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
extern struct spi_device *
spi_new_device(struct spi_master *, struct spi_board_info *);

static inline void
spi_unregister_device(struct spi_device *spi)
{
	if (spi)
		device_unregister(&spi->dev);
}

1049 1050 1051
extern const struct spi_device_id *
spi_get_device_id(const struct spi_device *sdev);

1052 1053 1054 1055 1056 1057
static inline bool
spi_transfer_is_last(struct spi_master *master, struct spi_transfer *xfer)
{
	return list_is_last(&xfer->transfer_list, &master->cur_msg->transfers);
}

1058
#endif /* __LINUX_SPI_H */