xref: /linux/include/soc/bcm2835/raspberrypi-firmware.h (revision 48dea9a700c8728cc31a1dd44588b97578de86ee)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *  Copyright © 2015 Broadcom
4  */
5 
6 #ifndef __SOC_RASPBERRY_FIRMWARE_H__
7 #define __SOC_RASPBERRY_FIRMWARE_H__
8 
9 #include <linux/types.h>
10 #include <linux/of_device.h>
11 
12 struct rpi_firmware;
13 struct pci_dev;
14 
15 enum rpi_firmware_property_status {
16 	RPI_FIRMWARE_STATUS_REQUEST = 0,
17 	RPI_FIRMWARE_STATUS_SUCCESS = 0x80000000,
18 	RPI_FIRMWARE_STATUS_ERROR =   0x80000001,
19 };
20 
21 /**
22  * struct rpi_firmware_property_tag_header - Firmware property tag header
23  * @tag:		One of enum_mbox_property_tag.
24  * @buf_size:		The number of bytes in the value buffer following this
25  *			struct.
26  * @req_resp_size:	On submit, the length of the request (though it doesn't
27  *			appear to be currently used by the firmware).  On return,
28  *			the length of the response (always 4 byte aligned), with
29  *			the low bit set.
30  */
31 struct rpi_firmware_property_tag_header {
32 	u32 tag;
33 	u32 buf_size;
34 	u32 req_resp_size;
35 };
36 
37 enum rpi_firmware_property_tag {
38 	RPI_FIRMWARE_PROPERTY_END =                           0,
39 	RPI_FIRMWARE_GET_FIRMWARE_REVISION =                  0x00000001,
40 
41 	RPI_FIRMWARE_SET_CURSOR_INFO =                        0x00008010,
42 	RPI_FIRMWARE_SET_CURSOR_STATE =                       0x00008011,
43 
44 	RPI_FIRMWARE_GET_BOARD_MODEL =                        0x00010001,
45 	RPI_FIRMWARE_GET_BOARD_REVISION =                     0x00010002,
46 	RPI_FIRMWARE_GET_BOARD_MAC_ADDRESS =                  0x00010003,
47 	RPI_FIRMWARE_GET_BOARD_SERIAL =                       0x00010004,
48 	RPI_FIRMWARE_GET_ARM_MEMORY =                         0x00010005,
49 	RPI_FIRMWARE_GET_VC_MEMORY =                          0x00010006,
50 	RPI_FIRMWARE_GET_CLOCKS =                             0x00010007,
51 	RPI_FIRMWARE_GET_POWER_STATE =                        0x00020001,
52 	RPI_FIRMWARE_GET_TIMING =                             0x00020002,
53 	RPI_FIRMWARE_SET_POWER_STATE =                        0x00028001,
54 	RPI_FIRMWARE_GET_CLOCK_STATE =                        0x00030001,
55 	RPI_FIRMWARE_GET_CLOCK_RATE =                         0x00030002,
56 	RPI_FIRMWARE_GET_VOLTAGE =                            0x00030003,
57 	RPI_FIRMWARE_GET_MAX_CLOCK_RATE =                     0x00030004,
58 	RPI_FIRMWARE_GET_MAX_VOLTAGE =                        0x00030005,
59 	RPI_FIRMWARE_GET_TEMPERATURE =                        0x00030006,
60 	RPI_FIRMWARE_GET_MIN_CLOCK_RATE =                     0x00030007,
61 	RPI_FIRMWARE_GET_MIN_VOLTAGE =                        0x00030008,
62 	RPI_FIRMWARE_GET_TURBO =                              0x00030009,
63 	RPI_FIRMWARE_GET_MAX_TEMPERATURE =                    0x0003000a,
64 	RPI_FIRMWARE_GET_STC =                                0x0003000b,
65 	RPI_FIRMWARE_ALLOCATE_MEMORY =                        0x0003000c,
66 	RPI_FIRMWARE_LOCK_MEMORY =                            0x0003000d,
67 	RPI_FIRMWARE_UNLOCK_MEMORY =                          0x0003000e,
68 	RPI_FIRMWARE_RELEASE_MEMORY =                         0x0003000f,
69 	RPI_FIRMWARE_EXECUTE_CODE =                           0x00030010,
70 	RPI_FIRMWARE_EXECUTE_QPU =                            0x00030011,
71 	RPI_FIRMWARE_SET_ENABLE_QPU =                         0x00030012,
72 	RPI_FIRMWARE_GET_DISPMANX_RESOURCE_MEM_HANDLE =       0x00030014,
73 	RPI_FIRMWARE_GET_EDID_BLOCK =                         0x00030020,
74 	RPI_FIRMWARE_GET_CUSTOMER_OTP =                       0x00030021,
75 	RPI_FIRMWARE_GET_DOMAIN_STATE =                       0x00030030,
76 	RPI_FIRMWARE_GET_THROTTLED =                          0x00030046,
77 	RPI_FIRMWARE_GET_CLOCK_MEASURED =                     0x00030047,
78 	RPI_FIRMWARE_NOTIFY_REBOOT =                          0x00030048,
79 	RPI_FIRMWARE_SET_CLOCK_STATE =                        0x00038001,
80 	RPI_FIRMWARE_SET_CLOCK_RATE =                         0x00038002,
81 	RPI_FIRMWARE_SET_VOLTAGE =                            0x00038003,
82 	RPI_FIRMWARE_SET_TURBO =                              0x00038009,
83 	RPI_FIRMWARE_SET_CUSTOMER_OTP =                       0x00038021,
84 	RPI_FIRMWARE_SET_DOMAIN_STATE =                       0x00038030,
85 	RPI_FIRMWARE_GET_GPIO_STATE =                         0x00030041,
86 	RPI_FIRMWARE_SET_GPIO_STATE =                         0x00038041,
87 	RPI_FIRMWARE_SET_SDHOST_CLOCK =                       0x00038042,
88 	RPI_FIRMWARE_GET_GPIO_CONFIG =                        0x00030043,
89 	RPI_FIRMWARE_SET_GPIO_CONFIG =                        0x00038043,
90 	RPI_FIRMWARE_GET_PERIPH_REG =                         0x00030045,
91 	RPI_FIRMWARE_SET_PERIPH_REG =                         0x00038045,
92 	RPI_FIRMWARE_GET_POE_HAT_VAL =                        0x00030049,
93 	RPI_FIRMWARE_SET_POE_HAT_VAL =                        0x00030050,
94 	RPI_FIRMWARE_NOTIFY_XHCI_RESET =                      0x00030058,
95 
96 	/* Dispmanx TAGS */
97 	RPI_FIRMWARE_FRAMEBUFFER_ALLOCATE =                   0x00040001,
98 	RPI_FIRMWARE_FRAMEBUFFER_BLANK =                      0x00040002,
99 	RPI_FIRMWARE_FRAMEBUFFER_GET_PHYSICAL_WIDTH_HEIGHT =  0x00040003,
100 	RPI_FIRMWARE_FRAMEBUFFER_GET_VIRTUAL_WIDTH_HEIGHT =   0x00040004,
101 	RPI_FIRMWARE_FRAMEBUFFER_GET_DEPTH =                  0x00040005,
102 	RPI_FIRMWARE_FRAMEBUFFER_GET_PIXEL_ORDER =            0x00040006,
103 	RPI_FIRMWARE_FRAMEBUFFER_GET_ALPHA_MODE =             0x00040007,
104 	RPI_FIRMWARE_FRAMEBUFFER_GET_PITCH =                  0x00040008,
105 	RPI_FIRMWARE_FRAMEBUFFER_GET_VIRTUAL_OFFSET =         0x00040009,
106 	RPI_FIRMWARE_FRAMEBUFFER_GET_OVERSCAN =               0x0004000a,
107 	RPI_FIRMWARE_FRAMEBUFFER_GET_PALETTE =                0x0004000b,
108 	RPI_FIRMWARE_FRAMEBUFFER_GET_TOUCHBUF =               0x0004000f,
109 	RPI_FIRMWARE_FRAMEBUFFER_GET_GPIOVIRTBUF =            0x00040010,
110 	RPI_FIRMWARE_FRAMEBUFFER_RELEASE =                    0x00048001,
111 	RPI_FIRMWARE_FRAMEBUFFER_TEST_PHYSICAL_WIDTH_HEIGHT = 0x00044003,
112 	RPI_FIRMWARE_FRAMEBUFFER_TEST_VIRTUAL_WIDTH_HEIGHT =  0x00044004,
113 	RPI_FIRMWARE_FRAMEBUFFER_TEST_DEPTH =                 0x00044005,
114 	RPI_FIRMWARE_FRAMEBUFFER_TEST_PIXEL_ORDER =           0x00044006,
115 	RPI_FIRMWARE_FRAMEBUFFER_TEST_ALPHA_MODE =            0x00044007,
116 	RPI_FIRMWARE_FRAMEBUFFER_TEST_VIRTUAL_OFFSET =        0x00044009,
117 	RPI_FIRMWARE_FRAMEBUFFER_TEST_OVERSCAN =              0x0004400a,
118 	RPI_FIRMWARE_FRAMEBUFFER_TEST_PALETTE =               0x0004400b,
119 	RPI_FIRMWARE_FRAMEBUFFER_TEST_VSYNC =                 0x0004400e,
120 	RPI_FIRMWARE_FRAMEBUFFER_SET_PHYSICAL_WIDTH_HEIGHT =  0x00048003,
121 	RPI_FIRMWARE_FRAMEBUFFER_SET_VIRTUAL_WIDTH_HEIGHT =   0x00048004,
122 	RPI_FIRMWARE_FRAMEBUFFER_SET_DEPTH =                  0x00048005,
123 	RPI_FIRMWARE_FRAMEBUFFER_SET_PIXEL_ORDER =            0x00048006,
124 	RPI_FIRMWARE_FRAMEBUFFER_SET_ALPHA_MODE =             0x00048007,
125 	RPI_FIRMWARE_FRAMEBUFFER_SET_VIRTUAL_OFFSET =         0x00048009,
126 	RPI_FIRMWARE_FRAMEBUFFER_SET_OVERSCAN =               0x0004800a,
127 	RPI_FIRMWARE_FRAMEBUFFER_SET_PALETTE =                0x0004800b,
128 	RPI_FIRMWARE_FRAMEBUFFER_SET_TOUCHBUF =               0x0004801f,
129 	RPI_FIRMWARE_FRAMEBUFFER_SET_GPIOVIRTBUF =            0x00048020,
130 	RPI_FIRMWARE_FRAMEBUFFER_SET_VSYNC =                  0x0004800e,
131 	RPI_FIRMWARE_FRAMEBUFFER_SET_BACKLIGHT =              0x0004800f,
132 
133 	RPI_FIRMWARE_VCHIQ_INIT =                             0x00048010,
134 
135 	RPI_FIRMWARE_GET_COMMAND_LINE =                       0x00050001,
136 	RPI_FIRMWARE_GET_DMA_CHANNELS =                       0x00060001,
137 };
138 
139 #if IS_ENABLED(CONFIG_RASPBERRYPI_FIRMWARE)
140 int rpi_firmware_property(struct rpi_firmware *fw,
141 			  u32 tag, void *data, size_t len);
142 int rpi_firmware_property_list(struct rpi_firmware *fw,
143 			       void *data, size_t tag_size);
144 struct rpi_firmware *rpi_firmware_get(struct device_node *firmware_node);
145 int rpi_firmware_init_vl805(struct pci_dev *pdev);
146 #else
147 static inline int rpi_firmware_property(struct rpi_firmware *fw, u32 tag,
148 					void *data, size_t len)
149 {
150 	return -ENOSYS;
151 }
152 
153 static inline int rpi_firmware_property_list(struct rpi_firmware *fw,
154 					     void *data, size_t tag_size)
155 {
156 	return -ENOSYS;
157 }
158 
159 static inline struct rpi_firmware *rpi_firmware_get(struct device_node *firmware_node)
160 {
161 	return NULL;
162 }
163 
164 static inline int rpi_firmware_init_vl805(struct pci_dev *pdev)
165 {
166 	return 0;
167 }
168 #endif
169 
170 #endif /* __SOC_RASPBERRY_FIRMWARE_H__ */
171