include/soc/bcm2835/raspberrypi-firmware.h

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