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