include/spi.h

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