1 /* 2 * Common SPI Interface: Controller-specific definitions 3 * 4 * (C) Copyright 2001 5 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com. 6 * 7 * SPDX-License-Identifier: GPL-2.0+ 8 */ 9 10 #ifndef _SPI_H_ 11 #define _SPI_H_ 12 13 #include <common.h> 14 15 /* SPI mode flags */ 16 #define SPI_CPHA BIT(0) /* clock phase */ 17 #define SPI_CPOL BIT(1) /* clock polarity */ 18 #define SPI_MODE_0 (0|0) /* (original MicroWire) */ 19 #define SPI_MODE_1 (0|SPI_CPHA) 20 #define SPI_MODE_2 (SPI_CPOL|0) 21 #define SPI_MODE_3 (SPI_CPOL|SPI_CPHA) 22 #define SPI_CS_HIGH BIT(2) /* CS active high */ 23 #define SPI_LSB_FIRST BIT(3) /* per-word bits-on-wire */ 24 #define SPI_3WIRE BIT(4) /* SI/SO signals shared */ 25 #define SPI_LOOP BIT(5) /* loopback mode */ 26 #define SPI_SLAVE BIT(6) /* slave mode */ 27 #define SPI_PREAMBLE BIT(7) /* Skip preamble bytes */ 28 #define SPI_TX_BYTE BIT(8) /* transmit with 1 wire byte */ 29 #define SPI_TX_DUAL BIT(9) /* transmit with 2 wires */ 30 #define SPI_TX_QUAD BIT(10) /* transmit with 4 wires */ 31 #define SPI_RX_SLOW BIT(11) /* receive with 1 wire slow */ 32 #define SPI_RX_DUAL BIT(12) /* receive with 2 wires */ 33 #define SPI_RX_QUAD BIT(13) /* receive with 4 wires */ 34 #define SPI_DMA_PREPARE BIT(24) /* dma transfer skip waiting idle */ 35 36 /* Header byte that marks the start of the message */ 37 #define SPI_PREAMBLE_END_BYTE 0xec 38 39 #define SPI_DEFAULT_WORDLEN 8 40 41 #ifdef CONFIG_DM_SPI 42 /* TODO(sjg@chromium.org): Remove this and use max_hz from struct spi_slave */ 43 struct dm_spi_bus { 44 uint max_hz; 45 }; 46 47 /** 48 * struct dm_spi_platdata - platform data for all SPI slaves 49 * 50 * This describes a SPI slave, a child device of the SPI bus. To obtain this 51 * struct from a spi_slave, use dev_get_parent_platdata(dev) or 52 * dev_get_parent_platdata(slave->dev). 53 * 54 * This data is immuatable. Each time the device is probed, @max_hz and @mode 55 * will be copied to struct spi_slave. 56 * 57 * @cs: Chip select number (0..n-1) 58 * @max_hz: Maximum bus speed that this slave can tolerate 59 * @mode: SPI mode to use for this device (see SPI mode flags) 60 */ 61 struct dm_spi_slave_platdata { 62 unsigned int cs; 63 uint max_hz; 64 uint mode; 65 }; 66 67 #endif /* CONFIG_DM_SPI */ 68 69 /** 70 * struct spi_slave - Representation of a SPI slave 71 * 72 * For driver model this is the per-child data used by the SPI bus. It can 73 * be accessed using dev_get_parent_priv() on the slave device. The SPI uclass 74 * sets uip per_child_auto_alloc_size to sizeof(struct spi_slave), and the 75 * driver should not override it. Two platform data fields (max_hz and mode) 76 * are copied into this structure to provide an initial value. This allows 77 * them to be changed, since we should never change platform data in drivers. 78 * 79 * If not using driver model, drivers are expected to extend this with 80 * controller-specific data. 81 * 82 * @dev: SPI slave device 83 * @max_hz: Maximum speed for this slave 84 * @speed: Current bus speed. This is 0 until the bus is first 85 * claimed. 86 * @bus: ID of the bus that the slave is attached to. For 87 * driver model this is the sequence number of the SPI 88 * bus (bus->seq) so does not need to be stored 89 * @cs: ID of the chip select connected to the slave. 90 * @mode: SPI mode to use for this slave (see SPI mode flags) 91 * @wordlen: Size of SPI word in number of bits 92 * @max_read_size: If non-zero, the maximum number of bytes which can 93 * be read at once. 94 * @max_write_size: If non-zero, the maximum number of bytes which can 95 * be written at once. 96 * @memory_map: Address of read-only SPI flash access. 97 * @flags: Indication of SPI flags. 98 */ 99 struct spi_slave { 100 #ifdef CONFIG_DM_SPI 101 struct udevice *dev; /* struct spi_slave is dev->parentdata */ 102 uint max_hz; 103 uint speed; 104 #else 105 unsigned int bus; 106 unsigned int cs; 107 #endif 108 uint mode; 109 unsigned int wordlen; 110 unsigned int max_read_size; 111 unsigned int max_write_size; 112 void *memory_map; 113 u8 option; 114 115 u8 flags; 116 #define SPI_XFER_BEGIN BIT(0) /* Assert CS before transfer */ 117 #define SPI_XFER_END BIT(1) /* Deassert CS after transfer */ 118 #define SPI_XFER_ONCE (SPI_XFER_BEGIN | SPI_XFER_END) 119 #define SPI_XFER_MMAP BIT(2) /* Memory Mapped start */ 120 #define SPI_XFER_MMAP_END BIT(3) /* Memory Mapped End */ 121 #define SPI_XFER_PREPARE BIT(7) /* Transfer skip waiting idle */ 122 }; 123 124 /** 125 * Initialization, must be called once on start up. 126 * 127 * TODO: I don't think we really need this. 128 */ 129 void spi_init(void); 130 131 /** 132 * spi_do_alloc_slave - Allocate a new SPI slave (internal) 133 * 134 * Allocate and zero all fields in the spi slave, and set the bus/chip 135 * select. Use the helper macro spi_alloc_slave() to call this. 136 * 137 * @offset: Offset of struct spi_slave within slave structure. 138 * @size: Size of slave structure. 139 * @bus: Bus ID of the slave chip. 140 * @cs: Chip select ID of the slave chip on the specified bus. 141 */ 142 void *spi_do_alloc_slave(int offset, int size, unsigned int bus, 143 unsigned int cs); 144 145 /** 146 * spi_alloc_slave - Allocate a new SPI slave 147 * 148 * Allocate and zero all fields in the spi slave, and set the bus/chip 149 * select. 150 * 151 * @_struct: Name of structure to allocate (e.g. struct tegra_spi). 152 * This structure must contain a member 'struct spi_slave *slave'. 153 * @bus: Bus ID of the slave chip. 154 * @cs: Chip select ID of the slave chip on the specified bus. 155 */ 156 #define spi_alloc_slave(_struct, bus, cs) \ 157 spi_do_alloc_slave(offsetof(_struct, slave), \ 158 sizeof(_struct), bus, cs) 159 160 /** 161 * spi_alloc_slave_base - Allocate a new SPI slave with no private data 162 * 163 * Allocate and zero all fields in the spi slave, and set the bus/chip 164 * select. 165 * 166 * @bus: Bus ID of the slave chip. 167 * @cs: Chip select ID of the slave chip on the specified bus. 168 */ 169 #define spi_alloc_slave_base(bus, cs) \ 170 spi_do_alloc_slave(0, sizeof(struct spi_slave), bus, cs) 171 172 /** 173 * Set up communications parameters for a SPI slave. 174 * 175 * This must be called once for each slave. Note that this function 176 * usually doesn't touch any actual hardware, it only initializes the 177 * contents of spi_slave so that the hardware can be easily 178 * initialized later. 179 * 180 * @bus: Bus ID of the slave chip. 181 * @cs: Chip select ID of the slave chip on the specified bus. 182 * @max_hz: Maximum SCK rate in Hz. 183 * @mode: Clock polarity, clock phase and other parameters. 184 * 185 * Returns: A spi_slave reference that can be used in subsequent SPI 186 * calls, or NULL if one or more of the parameters are not supported. 187 */ 188 struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs, 189 unsigned int max_hz, unsigned int mode); 190 191 /** 192 * Free any memory associated with a SPI slave. 193 * 194 * @slave: The SPI slave 195 */ 196 void spi_free_slave(struct spi_slave *slave); 197 198 /** 199 * Claim the bus and prepare it for communication with a given slave. 200 * 201 * This must be called before doing any transfers with a SPI slave. It 202 * will enable and initialize any SPI hardware as necessary, and make 203 * sure that the SCK line is in the correct idle state. It is not 204 * allowed to claim the same bus for several slaves without releasing 205 * the bus in between. 206 * 207 * @slave: The SPI slave 208 * 209 * Returns: 0 if the bus was claimed successfully, or a negative value 210 * if it wasn't. 211 */ 212 int spi_claim_bus(struct spi_slave *slave); 213 214 /** 215 * Release the SPI bus 216 * 217 * This must be called once for every call to spi_claim_bus() after 218 * all transfers have finished. It may disable any SPI hardware as 219 * appropriate. 220 * 221 * @slave: The SPI slave 222 */ 223 void spi_release_bus(struct spi_slave *slave); 224 225 /** 226 * Set the word length for SPI transactions 227 * 228 * Set the word length (number of bits per word) for SPI transactions. 229 * 230 * @slave: The SPI slave 231 * @wordlen: The number of bits in a word 232 * 233 * Returns: 0 on success, -1 on failure. 234 */ 235 int spi_set_wordlen(struct spi_slave *slave, unsigned int wordlen); 236 237 /** 238 * SPI transfer 239 * 240 * This writes "bitlen" bits out the SPI MOSI port and simultaneously clocks 241 * "bitlen" bits in the SPI MISO port. That's just the way SPI works. 242 * 243 * The source of the outgoing bits is the "dout" parameter and the 244 * destination of the input bits is the "din" parameter. Note that "dout" 245 * and "din" can point to the same memory location, in which case the 246 * input data overwrites the output data (since both are buffered by 247 * temporary variables, this is OK). 248 * 249 * spi_xfer() interface: 250 * @slave: The SPI slave which will be sending/receiving the data. 251 * @bitlen: How many bits to write and read. 252 * @dout: Pointer to a string of bits to send out. The bits are 253 * held in a byte array and are sent MSB first. 254 * @din: Pointer to a string of bits that will be filled in. 255 * @flags: A bitwise combination of SPI_XFER_* flags. 256 * 257 * Returns: 0 on success, not 0 on failure 258 */ 259 int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout, 260 void *din, unsigned long flags); 261 262 /* Copy memory mapped data */ 263 void spi_flash_copy_mmap(void *data, void *offset, size_t len); 264 265 /** 266 * Determine if a SPI chipselect is valid. 267 * This function is provided by the board if the low-level SPI driver 268 * needs it to determine if a given chipselect is actually valid. 269 * 270 * Returns: 1 if bus:cs identifies a valid chip on this board, 0 271 * otherwise. 272 */ 273 int spi_cs_is_valid(unsigned int bus, unsigned int cs); 274 275 #ifndef CONFIG_DM_SPI 276 /** 277 * Activate a SPI chipselect. 278 * This function is provided by the board code when using a driver 279 * that can't control its chipselects automatically (e.g. 280 * common/soft_spi.c). When called, it should activate the chip select 281 * to the device identified by "slave". 282 */ 283 void spi_cs_activate(struct spi_slave *slave); 284 285 /** 286 * Deactivate a SPI chipselect. 287 * This function is provided by the board code when using a driver 288 * that can't control its chipselects automatically (e.g. 289 * common/soft_spi.c). When called, it should deactivate the chip 290 * select to the device identified by "slave". 291 */ 292 void spi_cs_deactivate(struct spi_slave *slave); 293 294 /** 295 * Set transfer speed. 296 * This sets a new speed to be applied for next spi_xfer(). 297 * @slave: The SPI slave 298 * @hz: The transfer speed 299 */ 300 void spi_set_speed(struct spi_slave *slave, uint hz); 301 #endif 302 303 /** 304 * Write 8 bits, then read 8 bits. 305 * @slave: The SPI slave we're communicating with 306 * @byte: Byte to be written 307 * 308 * Returns: The value that was read, or a negative value on error. 309 * 310 * TODO: This function probably shouldn't be inlined. 311 */ 312 static inline int spi_w8r8(struct spi_slave *slave, unsigned char byte) 313 { 314 unsigned char dout[2]; 315 unsigned char din[2]; 316 int ret; 317 318 dout[0] = byte; 319 dout[1] = 0; 320 321 ret = spi_xfer(slave, 16, dout, din, SPI_XFER_BEGIN | SPI_XFER_END); 322 return ret < 0 ? ret : din[1]; 323 } 324 325 #ifdef CONFIG_DM_SPI 326 327 /** 328 * struct spi_cs_info - Information about a bus chip select 329 * 330 * @dev: Connected device, or NULL if none 331 */ 332 struct spi_cs_info { 333 struct udevice *dev; 334 }; 335 336 /** 337 * struct struct dm_spi_ops - Driver model SPI operations 338 * 339 * The uclass interface is implemented by all SPI devices which use 340 * driver model. 341 */ 342 struct dm_spi_ops { 343 /** 344 * Claim the bus and prepare it for communication. 345 * 346 * The device provided is the slave device. It's parent controller 347 * will be used to provide the communication. 348 * 349 * This must be called before doing any transfers with a SPI slave. It 350 * will enable and initialize any SPI hardware as necessary, and make 351 * sure that the SCK line is in the correct idle state. It is not 352 * allowed to claim the same bus for several slaves without releasing 353 * the bus in between. 354 * 355 * @dev: The SPI slave 356 * 357 * Returns: 0 if the bus was claimed successfully, or a negative value 358 * if it wasn't. 359 */ 360 int (*claim_bus)(struct udevice *dev); 361 362 /** 363 * Release the SPI bus 364 * 365 * This must be called once for every call to spi_claim_bus() after 366 * all transfers have finished. It may disable any SPI hardware as 367 * appropriate. 368 * 369 * @dev: The SPI slave 370 */ 371 int (*release_bus)(struct udevice *dev); 372 373 /** 374 * Set the word length for SPI transactions 375 * 376 * Set the word length (number of bits per word) for SPI transactions. 377 * 378 * @bus: The SPI slave 379 * @wordlen: The number of bits in a word 380 * 381 * Returns: 0 on success, -ve on failure. 382 */ 383 int (*set_wordlen)(struct udevice *dev, unsigned int wordlen); 384 385 /** 386 * SPI transfer 387 * 388 * This writes "bitlen" bits out the SPI MOSI port and simultaneously 389 * clocks "bitlen" bits in the SPI MISO port. That's just the way SPI 390 * works. 391 * 392 * The source of the outgoing bits is the "dout" parameter and the 393 * destination of the input bits is the "din" parameter. Note that 394 * "dout" and "din" can point to the same memory location, in which 395 * case the input data overwrites the output data (since both are 396 * buffered by temporary variables, this is OK). 397 * 398 * spi_xfer() interface: 399 * @dev: The slave device to communicate with 400 * @bitlen: How many bits to write and read. 401 * @dout: Pointer to a string of bits to send out. The bits are 402 * held in a byte array and are sent MSB first. 403 * @din: Pointer to a string of bits that will be filled in. 404 * @flags: A bitwise combination of SPI_XFER_* flags. 405 * 406 * Returns: 0 on success, not -1 on failure 407 */ 408 int (*xfer)(struct udevice *dev, unsigned int bitlen, const void *dout, 409 void *din, unsigned long flags); 410 411 /** 412 * Optimized handlers for SPI memory-like operations. 413 * 414 * Optimized/dedicated operations for interactions with SPI memory. This 415 * field is optional and should only be implemented if the controller 416 * has native support for memory like operations. 417 */ 418 const struct spi_controller_mem_ops *mem_ops; 419 420 /** 421 * Set transfer speed. 422 * This sets a new speed to be applied for next spi_xfer(). 423 * @bus: The SPI bus 424 * @hz: The transfer speed 425 * @return 0 if OK, -ve on error 426 */ 427 int (*set_speed)(struct udevice *bus, uint hz); 428 429 /** 430 * Set the SPI mode/flags 431 * 432 * It is unclear if we want to set speed and mode together instead 433 * of separately. 434 * 435 * @bus: The SPI bus 436 * @mode: Requested SPI mode (SPI_... flags) 437 * @return 0 if OK, -ve on error 438 */ 439 int (*set_mode)(struct udevice *bus, uint mode); 440 441 /** 442 * Get information on a chip select 443 * 444 * This is only called when the SPI uclass does not know about a 445 * chip select, i.e. it has no attached device. It gives the driver 446 * a chance to allow activity on that chip select even so. 447 * 448 * @bus: The SPI bus 449 * @cs: The chip select (0..n-1) 450 * @info: Returns information about the chip select, if valid. 451 * On entry info->dev is NULL 452 * @return 0 if OK (and @info is set up), -ENODEV if the chip select 453 * is invalid, other -ve value on error 454 */ 455 int (*cs_info)(struct udevice *bus, uint cs, struct spi_cs_info *info); 456 }; 457 458 struct dm_spi_emul_ops { 459 /** 460 * SPI transfer 461 * 462 * This writes "bitlen" bits out the SPI MOSI port and simultaneously 463 * clocks "bitlen" bits in the SPI MISO port. That's just the way SPI 464 * works. Here the device is a slave. 465 * 466 * The source of the outgoing bits is the "dout" parameter and the 467 * destination of the input bits is the "din" parameter. Note that 468 * "dout" and "din" can point to the same memory location, in which 469 * case the input data overwrites the output data (since both are 470 * buffered by temporary variables, this is OK). 471 * 472 * spi_xfer() interface: 473 * @slave: The SPI slave which will be sending/receiving the data. 474 * @bitlen: How many bits to write and read. 475 * @dout: Pointer to a string of bits sent to the device. The 476 * bits are held in a byte array and are sent MSB first. 477 * @din: Pointer to a string of bits that will be sent back to 478 * the master. 479 * @flags: A bitwise combination of SPI_XFER_* flags. 480 * 481 * Returns: 0 on success, not -1 on failure 482 */ 483 int (*xfer)(struct udevice *slave, unsigned int bitlen, 484 const void *dout, void *din, unsigned long flags); 485 }; 486 487 /** 488 * spi_find_bus_and_cs() - Find bus and slave devices by number 489 * 490 * Given a bus number and chip select, this finds the corresponding bus 491 * device and slave device. Neither device is activated by this function, 492 * although they may have been activated previously. 493 * 494 * @busnum: SPI bus number 495 * @cs: Chip select to look for 496 * @busp: Returns bus device 497 * @devp: Return slave device 498 * @return 0 if found, -ENODEV on error 499 */ 500 int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp, 501 struct udevice **devp); 502 503 /** 504 * spi_get_bus_and_cs() - Find and activate bus and slave devices by number 505 * 506 * Given a bus number and chip select, this finds the corresponding bus 507 * device and slave device. 508 * 509 * If no such slave exists, and drv_name is not NULL, then a new slave device 510 * is automatically bound on this chip select with requested speed and mode. 511 * 512 * Ths new slave device is probed ready for use with the speed and mode 513 * from platdata when available or the requested values. 514 * 515 * @busnum: SPI bus number 516 * @cs: Chip select to look for 517 * @speed: SPI speed to use for this slave when not available in platdata 518 * @mode: SPI mode to use for this slave when not available in platdata 519 * @drv_name: Name of driver to attach to this chip select 520 * @dev_name: Name of the new device thus created 521 * @busp: Returns bus device 522 * @devp: Return slave device 523 * @return 0 if found, -ve on error 524 */ 525 int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode, 526 const char *drv_name, const char *dev_name, 527 struct udevice **busp, struct spi_slave **devp); 528 529 /** 530 * spi_chip_select() - Get the chip select for a slave 531 * 532 * @return the chip select this slave is attached to 533 */ 534 int spi_chip_select(struct udevice *slave); 535 536 /** 537 * spi_find_chip_select() - Find the slave attached to chip select 538 * 539 * @bus: SPI bus to search 540 * @cs: Chip select to look for 541 * @devp: Returns the slave device if found 542 * @return 0 if found, -ENODEV on error 543 */ 544 int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp); 545 546 /** 547 * spi_slave_ofdata_to_platdata() - decode standard SPI platform data 548 * 549 * This decodes the speed and mode for a slave from a device tree node 550 * 551 * @blob: Device tree blob 552 * @node: Node offset to read from 553 * @plat: Place to put the decoded information 554 */ 555 int spi_slave_ofdata_to_platdata(struct udevice *dev, 556 struct dm_spi_slave_platdata *plat); 557 558 /** 559 * spi_cs_info() - Check information on a chip select 560 * 561 * This checks a particular chip select on a bus to see if it has a device 562 * attached, or is even valid. 563 * 564 * @bus: The SPI bus 565 * @cs: The chip select (0..n-1) 566 * @info: Returns information about the chip select, if valid 567 * @return 0 if OK (and @info is set up), -ENODEV if the chip select 568 * is invalid, other -ve value on error 569 */ 570 int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info); 571 572 struct sandbox_state; 573 574 /** 575 * sandbox_spi_get_emul() - get an emulator for a SPI slave 576 * 577 * This provides a way to attach an emulated SPI device to a particular SPI 578 * slave, so that xfer() operations on the slave will be handled by the 579 * emulator. If a emulator already exists on that chip select it is returned. 580 * Otherwise one is created. 581 * 582 * @state: Sandbox state 583 * @bus: SPI bus requesting the emulator 584 * @slave: SPI slave device requesting the emulator 585 * @emuip: Returns pointer to emulator 586 * @return 0 if OK, -ve on error 587 */ 588 int sandbox_spi_get_emul(struct sandbox_state *state, 589 struct udevice *bus, struct udevice *slave, 590 struct udevice **emulp); 591 592 /** 593 * Claim the bus and prepare it for communication with a given slave. 594 * 595 * This must be called before doing any transfers with a SPI slave. It 596 * will enable and initialize any SPI hardware as necessary, and make 597 * sure that the SCK line is in the correct idle state. It is not 598 * allowed to claim the same bus for several slaves without releasing 599 * the bus in between. 600 * 601 * @dev: The SPI slave device 602 * 603 * Returns: 0 if the bus was claimed successfully, or a negative value 604 * if it wasn't. 605 */ 606 int dm_spi_claim_bus(struct udevice *dev); 607 608 /** 609 * Release the SPI bus 610 * 611 * This must be called once for every call to dm_spi_claim_bus() after 612 * all transfers have finished. It may disable any SPI hardware as 613 * appropriate. 614 * 615 * @slave: The SPI slave device 616 */ 617 void dm_spi_release_bus(struct udevice *dev); 618 619 /** 620 * SPI transfer 621 * 622 * This writes "bitlen" bits out the SPI MOSI port and simultaneously clocks 623 * "bitlen" bits in the SPI MISO port. That's just the way SPI works. 624 * 625 * The source of the outgoing bits is the "dout" parameter and the 626 * destination of the input bits is the "din" parameter. Note that "dout" 627 * and "din" can point to the same memory location, in which case the 628 * input data overwrites the output data (since both are buffered by 629 * temporary variables, this is OK). 630 * 631 * dm_spi_xfer() interface: 632 * @dev: The SPI slave device which will be sending/receiving the data. 633 * @bitlen: How many bits to write and read. 634 * @dout: Pointer to a string of bits to send out. The bits are 635 * held in a byte array and are sent MSB first. 636 * @din: Pointer to a string of bits that will be filled in. 637 * @flags: A bitwise combination of SPI_XFER_* flags. 638 * 639 * Returns: 0 on success, not 0 on failure 640 */ 641 int dm_spi_xfer(struct udevice *dev, unsigned int bitlen, 642 const void *dout, void *din, unsigned long flags); 643 644 /* Access the operations for a SPI device */ 645 #define spi_get_ops(dev) ((struct dm_spi_ops *)(dev)->driver->ops) 646 #define spi_emul_get_ops(dev) ((struct dm_spi_emul_ops *)(dev)->driver->ops) 647 #endif /* CONFIG_DM_SPI */ 648 649 #endif /* _SPI_H_ */ 650