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