xref: /optee_os/core/include/spi.h (revision 8e81e2f5366a971afdd2ac47fb8529d1def5feb0)
1 /*
2  * Copyright (c) 2016, Linaro Limited
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef __SPI_H__
29 #define __SPI_H__
30 
31 #include <types_ext.h>
32 
33 enum spi_mode {
34 	SPI_MODE0,
35 	SPI_MODE1,
36 	SPI_MODE2,
37 	SPI_MODE3
38 };
39 
40 enum spi_result {
41 	SPI_OK,
42 	SPI_ERR_CFG,
43 	SPI_ERR_PKTCNT,
44 	SPI_ERR_GENERIC
45 };
46 
47 struct spi_chip {
48 	const struct spi_ops *ops;
49 };
50 
51 struct spi_ops {
52 	void (*configure)(struct spi_chip *chip);
53 	void (*start)(struct spi_chip *chip);
54 	enum spi_result (*txrx8)(struct spi_chip *chip, uint8_t *wdat,
55 		uint8_t *rdat, size_t num_pkts);
56 	enum spi_result (*txrx16)(struct spi_chip *chip, uint16_t *wdat,
57 		uint16_t *rdat, size_t num_pkts);
58 	void (*end)(struct spi_chip *chip);
59 };
60 
61 #endif	/* __SPI_H__ */
62 
63