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