xref: /optee_os/core/include/drivers/pl022_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 
30 #ifndef __PL022_SPI_H__
31 #define __PL022_SPI_H__
32 
33 #include <gpio.h>
34 #include <spi.h>
35 
36 #define PL022_REG_SIZE	0x1000
37 
38 enum pl022_cs_control {
39 	PL022_CS_CTRL_AUTO_GPIO,
40 	PL022_CS_CTRL_CB,
41 	PL022_CS_CTRL_MANUAL
42 };
43 
44 struct pl022_cs_gpio_data {
45 	struct gpio_chip	*chip;
46 	unsigned int		pin_num;
47 };
48 
49 union pl022_cs_data {
50 	struct pl022_cs_gpio_data	gpio_data;
51 	void				(*cs_cb)(enum gpio_level value);
52 };
53 
54 struct pl022_data {
55 	union pl022_cs_data	cs_data;
56 	struct spi_chip		chip;
57 	vaddr_t			base;
58 	enum spi_mode		mode;
59 	enum pl022_cs_control	cs_control;
60 	unsigned int		clk_hz;
61 	unsigned int		speed_hz;
62 	unsigned int		data_size_bits;
63 	bool			loopback;
64 };
65 
66 void pl022_init(struct pl022_data *pd);
67 
68 #endif	/* __PL022_SPI_H__ */
69 
70