include/spi.h

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