1 /*
2  * Copyright (c) 2013 Corey Tabaka
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 #ifndef __DEV_CLASS_SPI_H
24 #define __DEV_CLASS_SPI_H
25 
26 #include <compiler.h>
27 #include <dev/driver.h>
28 
29 /* spi transaction flags */
30 enum spi_flags {
31     SPI_READ        = (1<<0),
32     SPI_WRITE       = (1<<1),
33     SPI_CS_ASSERT   = (1<<2),
34     SPI_CS_DEASSERT = (1<<3),
35 };
36 
37 /* spi transaction */
38 struct spi_transaction {
39     enum spi_flags flags;
40     void *tx_buf;
41     void *rx_buf;
42     size_t len;
43 };
44 
45 /* spi interface */
46 struct spi_ops {
47     struct driver_ops std;
48 
49     ssize_t (*transaction)(struct device *dev, struct spi_transaction *txn, size_t count);
50 };
51 
52 __BEGIN_CDECLS
53 
54 ssize_t class_spi_transaction(struct device *dev, struct spi_transaction *txn, size_t count);
55 
56 __END_CDECLS
57 
58 #endif
59 
60