arch/arm/include/asm/arch-bcm2835/mbox.h

   1 /*
   2  * (C) Copyright 2012,2015 Stephen Warren
   3  *
   4  * SPDX-License-Identifier:     GPL-2.0+
   5  */
   6
   7 #ifndef _BCM2835_MBOX_H
   8 #define _BCM2835_MBOX_H
   9
  10 #include <linux/compiler.h>
  11
  12 /*
  13  * The BCM2835 SoC contains (at least) two CPUs; the VideoCore (a/k/a "GPU")
  14  * and the ARM CPU. The ARM CPU is often thought of as the main CPU.
  15  * However, the VideoCore actually controls the initial SoC boot, and hides
  16  * much of the hardware behind a protocol. This protocol is transported
  17  * using the SoC's mailbox hardware module.
  18  *
  19  * The mailbox hardware supports passing 32-bit values back and forth.
  20  * Presumably by software convention of the firmware, the bottom 4 bits of the
  21  * value are used to indicate a logical channel, and the upper 28 bits are the
  22  * actual payload. Various channels exist using these simple raw messages. See
  23  * https://github.com/raspberrypi/firmware/wiki/Mailboxes for a list. As an
  24  * example, the messages on the power management channel are a bitmask of
  25  * devices whose power should be enabled.
  26  *
  27  * The property mailbox channel passes messages that contain the (16-byte
  28  * aligned) ARM physical address of a memory buffer. This buffer is passed to
  29  * the VC for processing, is modified in-place by the VC, and the address then
  30  * passed back to the ARM CPU as the response mailbox message to indicate
  31  * request completion. The buffers have a generic and extensible format; each
  32  * buffer contains a standard header, a list of "tags", and a terminating zero
  33  * entry. Each tag contains an ID indicating its type, and length fields for
  34  * generic parsing. With some limitations, an arbitrary set of tags may be
  35  * combined together into a single message buffer. This file defines structs
  36  * representing the header and many individual tag layouts and IDs.
  37  */
  38
  39 /* Raw mailbox HW */
  40
  41 #ifdef CONFIG_BCM2836
  42 #define BCM2835_MBOX_PHYSADDR   0x3f00b880
  43 #else
  44 #define BCM2835_MBOX_PHYSADDR   0x2000b880
  45 #endif
  46
  47 struct bcm2835_mbox_regs {
  48         u32 read;
  49         u32 rsvd0[5];
  50         u32 status;
  51         u32 config;
  52         u32 write;
  53 };
  54
  55 #define BCM2835_MBOX_STATUS_WR_FULL     0x80000000
  56 #define BCM2835_MBOX_STATUS_RD_EMPTY    0x40000000
  57
  58 /* Lower 4-bits are channel ID */
  59 #define BCM2835_CHAN_MASK               0xf
  60 #define BCM2835_MBOX_PACK(chan, data)   (((data) & (~BCM2835_CHAN_MASK)) | \
  61                                          (chan & BCM2835_CHAN_MASK))
  62 #define BCM2835_MBOX_UNPACK_CHAN(val)   ((val) & BCM2835_CHAN_MASK)
  63 #define BCM2835_MBOX_UNPACK_DATA(val)   ((val) & (~BCM2835_CHAN_MASK))
  64
  65 /* Property mailbox buffer structures */
  66
  67 #define BCM2835_MBOX_PROP_CHAN          8
  68
  69 /* All message buffers must start with this header */
  70 struct bcm2835_mbox_hdr {
  71         u32 buf_size;
  72         u32 code;
  73 };
  74
  75 #define BCM2835_MBOX_REQ_CODE           0
  76 #define BCM2835_MBOX_RESP_CODE_SUCCESS  0x80000000
  77
  78 #define BCM2835_MBOX_INIT_HDR(_m_) { \
  79                 memset((_m_), 0, sizeof(*(_m_))); \
  80                 (_m_)->hdr.buf_size = sizeof(*(_m_)); \
  81                 (_m_)->hdr.code = 0; \
  82                 (_m_)->end_tag = 0; \
  83         }
  84
  85 /*
  86  * A message buffer contains a list of tags. Each tag must also start with
  87  * a standardized header.
  88  */
  89 struct bcm2835_mbox_tag_hdr {
  90         u32 tag;
  91         u32 val_buf_size;
  92         u32 val_len;
  93 };
  94
  95 #define BCM2835_MBOX_INIT_TAG(_t_, _id_) { \
  96                 (_t_)->tag_hdr.tag = BCM2835_MBOX_TAG_##_id_; \
  97                 (_t_)->tag_hdr.val_buf_size = sizeof((_t_)->body); \
  98                 (_t_)->tag_hdr.val_len = sizeof((_t_)->body.req); \
  99         }
 100
 101 #define BCM2835_MBOX_INIT_TAG_NO_REQ(_t_, _id_) { \
 102                 (_t_)->tag_hdr.tag = BCM2835_MBOX_TAG_##_id_; \
 103                 (_t_)->tag_hdr.val_buf_size = sizeof((_t_)->body); \
 104                 (_t_)->tag_hdr.val_len = 0; \
 105         }
 106
 107 /* When responding, the VC sets this bit in val_len to indicate a response */
 108 #define BCM2835_MBOX_TAG_VAL_LEN_RESPONSE       0x80000000
 109
 110 /*
 111  * Below we define the ID and struct for many possible tags. This header only
 112  * defines individual tag structs, not entire message structs, since in
 113  * general an arbitrary set of tags may be combined into a single message.
 114  * Clients of the mbox API are expected to define their own overall message
 115  * structures by combining the header, a set of tags, and a terminating
 116  * entry. For example,
 117  *
 118  * struct msg {
 119  *     struct bcm2835_mbox_hdr hdr;
 120  *     struct bcm2835_mbox_tag_get_arm_mem get_arm_mem;
 121  *     ... perhaps other tags here ...
 122  *     u32 end_tag;
 123  * };
 124  */
 125
 126 #define BCM2835_MBOX_TAG_GET_BOARD_REV  0x00010002
 127
 128 /*
 129  * 0x2..0xf from:
 130  * http://raspberryalphaomega.org.uk/2013/02/06/automatic-raspberry-pi-board-revision-detection-model-a-b1-and-b2/
 131  * http://www.raspberrypi.org/forums/viewtopic.php?f=63&t=32733
 132  * 0x10, 0x11 from swarren's testing
 133  */
 134 #define BCM2835_BOARD_REV_B_I2C0_2      0x2
 135 #define BCM2835_BOARD_REV_B_I2C0_3      0x3
 136 #define BCM2835_BOARD_REV_B_I2C1_4      0x4
 137 #define BCM2835_BOARD_REV_B_I2C1_5      0x5
 138 #define BCM2835_BOARD_REV_B_I2C1_6      0x6
 139 #define BCM2835_BOARD_REV_A_7           0x7
 140 #define BCM2835_BOARD_REV_A_8           0x8
 141 #define BCM2835_BOARD_REV_A_9           0x9
 142 #define BCM2835_BOARD_REV_B_REV2_d      0xd
 143 #define BCM2835_BOARD_REV_B_REV2_e      0xe
 144 #define BCM2835_BOARD_REV_B_REV2_f      0xf
 145 #define BCM2835_BOARD_REV_B_PLUS        0x10
 146 #define BCM2835_BOARD_REV_CM            0x11
 147 #define BCM2835_BOARD_REV_A_PLUS        0x12
 148
 149 struct bcm2835_mbox_tag_get_board_rev {
 150         struct bcm2835_mbox_tag_hdr tag_hdr;
 151         union {
 152                 struct {
 153                 } req;
 154                 struct {
 155                         u32 rev;
 156                 } resp;
 157         } body;
 158 };
 159
 160 #define BCM2835_MBOX_TAG_GET_MAC_ADDRESS        0x00010003
 161
 162 struct bcm2835_mbox_tag_get_mac_address {
 163         struct bcm2835_mbox_tag_hdr tag_hdr;
 164         union {
 165                 struct {
 166                 } req;
 167                 struct {
 168                         u8 mac[6];
 169                         u8 pad[2];
 170                 } resp;
 171         } body;
 172 };
 173
 174 #define BCM2835_MBOX_TAG_GET_ARM_MEMORY         0x00010005
 175
 176 struct bcm2835_mbox_tag_get_arm_mem {
 177         struct bcm2835_mbox_tag_hdr tag_hdr;
 178         union {
 179                 struct {
 180                 } req;
 181                 struct {
 182                         u32 mem_base;
 183                         u32 mem_size;
 184                 } resp;
 185         } body;
 186 };
 187
 188 #define BCM2835_MBOX_POWER_DEVID_SDHCI          0
 189 #define BCM2835_MBOX_POWER_DEVID_UART0          1
 190 #define BCM2835_MBOX_POWER_DEVID_UART1          2
 191 #define BCM2835_MBOX_POWER_DEVID_USB_HCD        3
 192 #define BCM2835_MBOX_POWER_DEVID_I2C0           4
 193 #define BCM2835_MBOX_POWER_DEVID_I2C1           5
 194 #define BCM2835_MBOX_POWER_DEVID_I2C2           6
 195 #define BCM2835_MBOX_POWER_DEVID_SPI            7
 196 #define BCM2835_MBOX_POWER_DEVID_CCP2TX         8
 197
 198 #define BCM2835_MBOX_POWER_STATE_RESP_ON        (1 << 0)
 199 /* Device doesn't exist */
 200 #define BCM2835_MBOX_POWER_STATE_RESP_NODEV     (1 << 1)
 201
 202 #define BCM2835_MBOX_TAG_GET_POWER_STATE        0x00020001
 203
 204 struct bcm2835_mbox_tag_get_power_state {
 205         struct bcm2835_mbox_tag_hdr tag_hdr;
 206         union {
 207                 struct {
 208                         u32 device_id;
 209                 } req;
 210                 struct {
 211                         u32 device_id;
 212                         u32 state;
 213                 } resp;
 214         } body;
 215 };
 216
 217 #define BCM2835_MBOX_TAG_SET_POWER_STATE        0x00028001
 218
 219 #define BCM2835_MBOX_SET_POWER_STATE_REQ_ON     (1 << 0)
 220 #define BCM2835_MBOX_SET_POWER_STATE_REQ_WAIT   (1 << 1)
 221
 222 struct bcm2835_mbox_tag_set_power_state {
 223         struct bcm2835_mbox_tag_hdr tag_hdr;
 224         union {
 225                 struct {
 226                         u32 device_id;
 227                         u32 state;
 228                 } req;
 229                 struct {
 230                         u32 device_id;
 231                         u32 state;
 232                 } resp;
 233         } body;
 234 };
 235
 236 #define BCM2835_MBOX_TAG_GET_CLOCK_RATE 0x00030002
 237
 238 #define BCM2835_MBOX_CLOCK_ID_EMMC      1
 239 #define BCM2835_MBOX_CLOCK_ID_UART      2
 240 #define BCM2835_MBOX_CLOCK_ID_ARM       3
 241 #define BCM2835_MBOX_CLOCK_ID_CORE      4
 242 #define BCM2835_MBOX_CLOCK_ID_V3D       5
 243 #define BCM2835_MBOX_CLOCK_ID_H264      6
 244 #define BCM2835_MBOX_CLOCK_ID_ISP       7
 245 #define BCM2835_MBOX_CLOCK_ID_SDRAM     8
 246 #define BCM2835_MBOX_CLOCK_ID_PIXEL     9
 247 #define BCM2835_MBOX_CLOCK_ID_PWM       10
 248
 249 struct bcm2835_mbox_tag_get_clock_rate {
 250         struct bcm2835_mbox_tag_hdr tag_hdr;
 251         union {
 252                 struct {
 253                         u32 clock_id;
 254                 } req;
 255                 struct {
 256                         u32 clock_id;
 257                         u32 rate_hz;
 258                 } resp;
 259         } body;
 260 };
 261
 262 #define BCM2835_MBOX_TAG_ALLOCATE_BUFFER        0x00040001
 263
 264 struct bcm2835_mbox_tag_allocate_buffer {
 265         struct bcm2835_mbox_tag_hdr tag_hdr;
 266         union {
 267                 struct {
 268                         u32 alignment;
 269                 } req;
 270                 struct {
 271                         u32 fb_address;
 272                         u32 fb_size;
 273                 } resp;
 274         } body;
 275 };
 276
 277 #define BCM2835_MBOX_TAG_RELEASE_BUFFER         0x00048001
 278
 279 struct bcm2835_mbox_tag_release_buffer {
 280         struct bcm2835_mbox_tag_hdr tag_hdr;
 281         union {
 282                 struct {
 283                 } req;
 284                 struct {
 285                 } resp;
 286         } body;
 287 };
 288
 289 #define BCM2835_MBOX_TAG_BLANK_SCREEN           0x00040002
 290
 291 struct bcm2835_mbox_tag_blank_screen {
 292         struct bcm2835_mbox_tag_hdr tag_hdr;
 293         union {
 294                 struct {
 295                         /* bit 0 means on, other bots reserved */
 296                         u32 state;
 297                 } req;
 298                 struct {
 299                         u32 state;
 300                 } resp;
 301         } body;
 302 };
 303
 304 /* Physical means output signal */
 305 #define BCM2835_MBOX_TAG_GET_PHYSICAL_W_H       0x00040003
 306 #define BCM2835_MBOX_TAG_TEST_PHYSICAL_W_H      0x00044003
 307 #define BCM2835_MBOX_TAG_SET_PHYSICAL_W_H       0x00048003
 308
 309 struct bcm2835_mbox_tag_physical_w_h {
 310         struct bcm2835_mbox_tag_hdr tag_hdr;
 311         union {
 312                 /* req not used for get */
 313                 struct {
 314                         u32 width;
 315                         u32 height;
 316                 } req;
 317                 struct {
 318                         u32 width;
 319                         u32 height;
 320                 } resp;
 321         } body;
 322 };
 323
 324 /* Virtual means display buffer */
 325 #define BCM2835_MBOX_TAG_GET_VIRTUAL_W_H        0x00040004
 326 #define BCM2835_MBOX_TAG_TEST_VIRTUAL_W_H       0x00044004
 327 #define BCM2835_MBOX_TAG_SET_VIRTUAL_W_H        0x00048004
 328
 329 struct bcm2835_mbox_tag_virtual_w_h {
 330         struct bcm2835_mbox_tag_hdr tag_hdr;
 331         union {
 332                 /* req not used for get */
 333                 struct {
 334                         u32 width;
 335                         u32 height;
 336                 } req;
 337                 struct {
 338                         u32 width;
 339                         u32 height;
 340                 } resp;
 341         } body;
 342 };
 343
 344 #define BCM2835_MBOX_TAG_GET_DEPTH              0x00040005
 345 #define BCM2835_MBOX_TAG_TEST_DEPTH             0x00044005
 346 #define BCM2835_MBOX_TAG_SET_DEPTH              0x00048005
 347
 348 struct bcm2835_mbox_tag_depth {
 349         struct bcm2835_mbox_tag_hdr tag_hdr;
 350         union {
 351                 /* req not used for get */
 352                 struct {
 353                         u32 bpp;
 354                 } req;
 355                 struct {
 356                         u32 bpp;
 357                 } resp;
 358         } body;
 359 };
 360
 361 #define BCM2835_MBOX_TAG_GET_PIXEL_ORDER        0x00040006
 362 #define BCM2835_MBOX_TAG_TEST_PIXEL_ORDER       0x00044005
 363 #define BCM2835_MBOX_TAG_SET_PIXEL_ORDER        0x00048006
 364
 365 #define BCM2835_MBOX_PIXEL_ORDER_BGR            0
 366 #define BCM2835_MBOX_PIXEL_ORDER_RGB            1
 367
 368 struct bcm2835_mbox_tag_pixel_order {
 369         struct bcm2835_mbox_tag_hdr tag_hdr;
 370         union {
 371                 /* req not used for get */
 372                 struct {
 373                         u32 order;
 374                 } req;
 375                 struct {
 376                         u32 order;
 377                 } resp;
 378         } body;
 379 };
 380
 381 #define BCM2835_MBOX_TAG_GET_ALPHA_MODE         0x00040007
 382 #define BCM2835_MBOX_TAG_TEST_ALPHA_MODE        0x00044007
 383 #define BCM2835_MBOX_TAG_SET_ALPHA_MODE         0x00048007
 384
 385 #define BCM2835_MBOX_ALPHA_MODE_0_OPAQUE        0
 386 #define BCM2835_MBOX_ALPHA_MODE_0_TRANSPARENT   1
 387 #define BCM2835_MBOX_ALPHA_MODE_IGNORED         2
 388
 389 struct bcm2835_mbox_tag_alpha_mode {
 390         struct bcm2835_mbox_tag_hdr tag_hdr;
 391         union {
 392                 /* req not used for get */
 393                 struct {
 394                         u32 alpha;
 395                 } req;
 396                 struct {
 397                         u32 alpha;
 398                 } resp;
 399         } body;
 400 };
 401
 402 #define BCM2835_MBOX_TAG_GET_PITCH              0x00040008
 403
 404 struct bcm2835_mbox_tag_pitch {
 405         struct bcm2835_mbox_tag_hdr tag_hdr;
 406         union {
 407                 struct {
 408                 } req;
 409                 struct {
 410                         u32 pitch;
 411                 } resp;
 412         } body;
 413 };
 414
 415 /* Offset of display window within buffer */
 416 #define BCM2835_MBOX_TAG_GET_VIRTUAL_OFFSET     0x00040009
 417 #define BCM2835_MBOX_TAG_TEST_VIRTUAL_OFFSET    0x00044009
 418 #define BCM2835_MBOX_TAG_SET_VIRTUAL_OFFSET     0x00048009
 419
 420 struct bcm2835_mbox_tag_virtual_offset {
 421         struct bcm2835_mbox_tag_hdr tag_hdr;
 422         union {
 423                 /* req not used for get */
 424                 struct {
 425                         u32 x;
 426                         u32 y;
 427                 } req;
 428                 struct {
 429                         u32 x;
 430                         u32 y;
 431                 } resp;
 432         } body;
 433 };
 434
 435 #define BCM2835_MBOX_TAG_GET_OVERSCAN           0x0004000a
 436 #define BCM2835_MBOX_TAG_TEST_OVERSCAN          0x0004400a
 437 #define BCM2835_MBOX_TAG_SET_OVERSCAN           0x0004800a
 438
 439 struct bcm2835_mbox_tag_overscan {
 440         struct bcm2835_mbox_tag_hdr tag_hdr;
 441         union {
 442                 /* req not used for get */
 443                 struct {
 444                         u32 top;
 445                         u32 bottom;
 446                         u32 left;
 447                         u32 right;
 448                 } req;
 449                 struct {
 450                         u32 top;
 451                         u32 bottom;
 452                         u32 left;
 453                         u32 right;
 454                 } resp;
 455         } body;
 456 };
 457
 458 #define BCM2835_MBOX_TAG_GET_PALETTE            0x0004000b
 459
 460 struct bcm2835_mbox_tag_get_palette {
 461         struct bcm2835_mbox_tag_hdr tag_hdr;
 462         union {
 463                 struct {
 464                 } req;
 465                 struct {
 466                         u32 data[1024];
 467                 } resp;
 468         } body;
 469 };
 470
 471 #define BCM2835_MBOX_TAG_TEST_PALETTE           0x0004400b
 472
 473 struct bcm2835_mbox_tag_test_palette {
 474         struct bcm2835_mbox_tag_hdr tag_hdr;
 475         union {
 476                 struct {
 477                         u32 offset;
 478                         u32 num_entries;
 479                         u32 data[256];
 480                 } req;
 481                 struct {
 482                         u32 is_invalid;
 483                 } resp;
 484         } body;
 485 };
 486
 487 #define BCM2835_MBOX_TAG_SET_PALETTE            0x0004800b
 488
 489 struct bcm2835_mbox_tag_set_palette {
 490         struct bcm2835_mbox_tag_hdr tag_hdr;
 491         union {
 492                 struct {
 493                         u32 offset;
 494                         u32 num_entries;
 495                         u32 data[256];
 496                 } req;
 497                 struct {
 498                         u32 is_invalid;
 499                 } resp;
 500         } body;
 501 };
 502
 503 /*
 504  * Pass a raw u32 message to the VC, and receive a raw u32 back.
 505  *
 506  * Returns 0 for success, any other value for error.
 507  */
 508 int bcm2835_mbox_call_raw(u32 chan, u32 send, u32 *recv);
 509
 510 /*
 511  * Pass a complete property-style buffer to the VC, and wait until it has
 512  * been processed.
 513  *
 514  * This function expects a pointer to the mbox_hdr structure in an attempt
 515  * to ensure some degree of type safety. However, some number of tags and
 516  * a termination value are expected to immediately follow the header in
 517  * memory, as required by the property protocol.
 518  *
 519  * Returns 0 for success, any other value for error.
 520  */
 521 int bcm2835_mbox_call_prop(u32 chan, struct bcm2835_mbox_hdr *buffer);
 522
 523 #endif