[linux-2.6-block.git] / include / soc / bcm2835 / raspberrypi-firmware.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  Copyright © 2015 Broadcom
 */

#ifndef __SOC_RASPBERRY_FIRMWARE_H__
#define __SOC_RASPBERRY_FIRMWARE_H__

#include <linux/types.h>
#include <linux/of_device.h>

struct rpi_firmware;

enum rpi_firmware_property_status {
	RPI_FIRMWARE_STATUS_REQUEST = 0,
	RPI_FIRMWARE_STATUS_SUCCESS = 0x80000000,
	RPI_FIRMWARE_STATUS_ERROR =   0x80000001,
};

/**
 * struct rpi_firmware_property_tag_header - Firmware property tag header
 * @tag:		One of enum_mbox_property_tag.
 * @buf_size:		The number of bytes in the value buffer following this
 *			struct.
 * @req_resp_size:	On submit, the length of the request (though it doesn't
 *			appear to be currently used by the firmware).  On return,
 *			the length of the response (always 4 byte aligned), with
 *			the low bit set.
 */
struct rpi_firmware_property_tag_header {
	u32 tag;
	u32 buf_size;
	u32 req_resp_size;
};

enum rpi_firmware_property_tag {
	RPI_FIRMWARE_PROPERTY_END =                           0,
	RPI_FIRMWARE_GET_FIRMWARE_REVISION =                  0x00000001,

	RPI_FIRMWARE_SET_CURSOR_INFO =                        0x00008010,
	RPI_FIRMWARE_SET_CURSOR_STATE =                       0x00008011,

	RPI_FIRMWARE_GET_BOARD_MODEL =                        0x00010001,
	RPI_FIRMWARE_GET_BOARD_REVISION =                     0x00010002,
	RPI_FIRMWARE_GET_BOARD_MAC_ADDRESS =                  0x00010003,
	RPI_FIRMWARE_GET_BOARD_SERIAL =                       0x00010004,
	RPI_FIRMWARE_GET_ARM_MEMORY =                         0x00010005,
	RPI_FIRMWARE_GET_VC_MEMORY =                          0x00010006,
	RPI_FIRMWARE_GET_CLOCKS =                             0x00010007,
	RPI_FIRMWARE_GET_POWER_STATE =                        0x00020001,
	RPI_FIRMWARE_GET_TIMING =                             0x00020002,
	RPI_FIRMWARE_SET_POWER_STATE =                        0x00028001,
	RPI_FIRMWARE_GET_CLOCK_STATE =                        0x00030001,
	RPI_FIRMWARE_GET_CLOCK_RATE =                         0x00030002,
	RPI_FIRMWARE_GET_VOLTAGE =                            0x00030003,
	RPI_FIRMWARE_GET_MAX_CLOCK_RATE =                     0x00030004,
	RPI_FIRMWARE_GET_MAX_VOLTAGE =                        0x00030005,
	RPI_FIRMWARE_GET_TEMPERATURE =                        0x00030006,
	RPI_FIRMWARE_GET_MIN_CLOCK_RATE =                     0x00030007,
	RPI_FIRMWARE_GET_MIN_VOLTAGE =                        0x00030008,
	RPI_FIRMWARE_GET_TURBO =                              0x00030009,
	RPI_FIRMWARE_GET_MAX_TEMPERATURE =                    0x0003000a,
	RPI_FIRMWARE_GET_STC =                                0x0003000b,
	RPI_FIRMWARE_ALLOCATE_MEMORY =                        0x0003000c,
	RPI_FIRMWARE_LOCK_MEMORY =                            0x0003000d,
	RPI_FIRMWARE_UNLOCK_MEMORY =                          0x0003000e,
	RPI_FIRMWARE_RELEASE_MEMORY =                         0x0003000f,
	RPI_FIRMWARE_EXECUTE_CODE =                           0x00030010,
	RPI_FIRMWARE_EXECUTE_QPU =                            0x00030011,
	RPI_FIRMWARE_SET_ENABLE_QPU =                         0x00030012,
	RPI_FIRMWARE_GET_DISPMANX_RESOURCE_MEM_HANDLE =       0x00030014,
	RPI_FIRMWARE_GET_EDID_BLOCK =                         0x00030020,
	RPI_FIRMWARE_GET_CUSTOMER_OTP =                       0x00030021,
	RPI_FIRMWARE_GET_DOMAIN_STATE =                       0x00030030,
	RPI_FIRMWARE_GET_THROTTLED =                          0x00030046,
	RPI_FIRMWARE_GET_CLOCK_MEASURED =                     0x00030047,
	RPI_FIRMWARE_NOTIFY_REBOOT =                          0x00030048,
	RPI_FIRMWARE_SET_CLOCK_STATE =                        0x00038001,
	RPI_FIRMWARE_SET_CLOCK_RATE =                         0x00038002,
	RPI_FIRMWARE_SET_VOLTAGE =                            0x00038003,
	RPI_FIRMWARE_SET_TURBO =                              0x00038009,
	RPI_FIRMWARE_SET_CUSTOMER_OTP =                       0x00038021,
	RPI_FIRMWARE_SET_DOMAIN_STATE =                       0x00038030,
	RPI_FIRMWARE_GET_GPIO_STATE =                         0x00030041,
	RPI_FIRMWARE_SET_GPIO_STATE =                         0x00038041,
	RPI_FIRMWARE_SET_SDHOST_CLOCK =                       0x00038042,
	RPI_FIRMWARE_GET_GPIO_CONFIG =                        0x00030043,
	RPI_FIRMWARE_SET_GPIO_CONFIG =                        0x00038043,
	RPI_FIRMWARE_GET_PERIPH_REG =                         0x00030045,
	RPI_FIRMWARE_SET_PERIPH_REG =                         0x00038045,
	RPI_FIRMWARE_GET_POE_HAT_VAL =                        0x00030049,
	RPI_FIRMWARE_SET_POE_HAT_VAL =                        0x00030050,


	/* Dispmanx TAGS */
	RPI_FIRMWARE_FRAMEBUFFER_ALLOCATE =                   0x00040001,
	RPI_FIRMWARE_FRAMEBUFFER_BLANK =                      0x00040002,
	RPI_FIRMWARE_FRAMEBUFFER_GET_PHYSICAL_WIDTH_HEIGHT =  0x00040003,
	RPI_FIRMWARE_FRAMEBUFFER_GET_VIRTUAL_WIDTH_HEIGHT =   0x00040004,
	RPI_FIRMWARE_FRAMEBUFFER_GET_DEPTH =                  0x00040005,
	RPI_FIRMWARE_FRAMEBUFFER_GET_PIXEL_ORDER =            0x00040006,
	RPI_FIRMWARE_FRAMEBUFFER_GET_ALPHA_MODE =             0x00040007,
	RPI_FIRMWARE_FRAMEBUFFER_GET_PITCH =                  0x00040008,
	RPI_FIRMWARE_FRAMEBUFFER_GET_VIRTUAL_OFFSET =         0x00040009,
	RPI_FIRMWARE_FRAMEBUFFER_GET_OVERSCAN =               0x0004000a,
	RPI_FIRMWARE_FRAMEBUFFER_GET_PALETTE =                0x0004000b,
	RPI_FIRMWARE_FRAMEBUFFER_GET_TOUCHBUF =               0x0004000f,
	RPI_FIRMWARE_FRAMEBUFFER_GET_GPIOVIRTBUF =            0x00040010,
	RPI_FIRMWARE_FRAMEBUFFER_RELEASE =                    0x00048001,
	RPI_FIRMWARE_FRAMEBUFFER_TEST_PHYSICAL_WIDTH_HEIGHT = 0x00044003,
	RPI_FIRMWARE_FRAMEBUFFER_TEST_VIRTUAL_WIDTH_HEIGHT =  0x00044004,
	RPI_FIRMWARE_FRAMEBUFFER_TEST_DEPTH =                 0x00044005,
	RPI_FIRMWARE_FRAMEBUFFER_TEST_PIXEL_ORDER =           0x00044006,
	RPI_FIRMWARE_FRAMEBUFFER_TEST_ALPHA_MODE =            0x00044007,
	RPI_FIRMWARE_FRAMEBUFFER_TEST_VIRTUAL_OFFSET =        0x00044009,
	RPI_FIRMWARE_FRAMEBUFFER_TEST_OVERSCAN =              0x0004400a,
	RPI_FIRMWARE_FRAMEBUFFER_TEST_PALETTE =               0x0004400b,
	RPI_FIRMWARE_FRAMEBUFFER_TEST_VSYNC =                 0x0004400e,
	RPI_FIRMWARE_FRAMEBUFFER_SET_PHYSICAL_WIDTH_HEIGHT =  0x00048003,
	RPI_FIRMWARE_FRAMEBUFFER_SET_VIRTUAL_WIDTH_HEIGHT =   0x00048004,
	RPI_FIRMWARE_FRAMEBUFFER_SET_DEPTH =                  0x00048005,
	RPI_FIRMWARE_FRAMEBUFFER_SET_PIXEL_ORDER =            0x00048006,
	RPI_FIRMWARE_FRAMEBUFFER_SET_ALPHA_MODE =             0x00048007,
	RPI_FIRMWARE_FRAMEBUFFER_SET_VIRTUAL_OFFSET =         0x00048009,
	RPI_FIRMWARE_FRAMEBUFFER_SET_OVERSCAN =               0x0004800a,
	RPI_FIRMWARE_FRAMEBUFFER_SET_PALETTE =                0x0004800b,
	RPI_FIRMWARE_FRAMEBUFFER_SET_TOUCHBUF =               0x0004801f,
	RPI_FIRMWARE_FRAMEBUFFER_SET_GPIOVIRTBUF =            0x00048020,
	RPI_FIRMWARE_FRAMEBUFFER_SET_VSYNC =                  0x0004800e,
	RPI_FIRMWARE_FRAMEBUFFER_SET_BACKLIGHT =              0x0004800f,

	RPI_FIRMWARE_VCHIQ_INIT =                             0x00048010,

	RPI_FIRMWARE_GET_COMMAND_LINE =                       0x00050001,
	RPI_FIRMWARE_GET_DMA_CHANNELS =                       0x00060001,
};

#if IS_ENABLED(CONFIG_RASPBERRYPI_FIRMWARE)
int rpi_firmware_property(struct rpi_firmware *fw,
			  u32 tag, void *data, size_t len);
int rpi_firmware_property_list(struct rpi_firmware *fw,
			       void *data, size_t tag_size);
struct rpi_firmware *rpi_firmware_get(struct device_node *firmware_node);
#else
static inline int rpi_firmware_property(struct rpi_firmware *fw, u32 tag,
					void *data, size_t len)
{
	return -ENOSYS;
}

static inline int rpi_firmware_property_list(struct rpi_firmware *fw,
					     void *data, size_t tag_size)
{
	return -ENOSYS;
}

static inline struct rpi_firmware *rpi_firmware_get(struct device_node *firmware_node)
{
	return NULL;
}
#endif

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