1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (c) 2018 MediaTek Inc. 4 * 5 */ 6 7 #ifndef __MTK_CMDQ_MAILBOX_H__ 8 #define __MTK_CMDQ_MAILBOX_H__ 9 10 #include <linux/platform_device.h> 11 #include <linux/slab.h> 12 #include <linux/types.h> 13 14 #define CMDQ_INST_SIZE 8 /* instruction is 64-bit */ 15 #define CMDQ_SUBSYS_SHIFT 16 16 #define CMDQ_OP_CODE_SHIFT 24 17 #define CMDQ_JUMP_PASS CMDQ_INST_SIZE 18 19 #define CMDQ_WFE_UPDATE BIT(31) 20 #define CMDQ_WFE_UPDATE_VALUE BIT(16) 21 #define CMDQ_WFE_WAIT BIT(15) 22 #define CMDQ_WFE_WAIT_VALUE 0x1 23 24 /* 25 * WFE arg_b 26 * bit 0-11: wait value 27 * bit 15: 1 - wait, 0 - no wait 28 * bit 16-27: update value 29 * bit 31: 1 - update, 0 - no update 30 */ 31 #define CMDQ_WFE_OPTION (CMDQ_WFE_WAIT | CMDQ_WFE_WAIT_VALUE) 32 33 /** cmdq event maximum */ 34 #define CMDQ_MAX_EVENT 0x3ff 35 36 /* 37 * CMDQ_CODE_MASK: 38 * set write mask 39 * format: op mask 40 * CMDQ_CODE_WRITE: 41 * write value into target register 42 * format: op subsys address value 43 * CMDQ_CODE_JUMP: 44 * jump by offset 45 * format: op offset 46 * CMDQ_CODE_WFE: 47 * wait for event and clear 48 * it is just clear if no wait 49 * format: [wait] op event update:1 to_wait:1 wait:1 50 * [clear] op event update:1 to_wait:0 wait:0 51 * CMDQ_CODE_EOC: 52 * end of command 53 * format: op irq_flag 54 */ 55 enum cmdq_code { 56 CMDQ_CODE_MASK = 0x02, 57 CMDQ_CODE_WRITE = 0x04, 58 CMDQ_CODE_POLL = 0x08, 59 CMDQ_CODE_JUMP = 0x10, 60 CMDQ_CODE_WFE = 0x20, 61 CMDQ_CODE_EOC = 0x40, 62 CMDQ_CODE_READ_S = 0x80, 63 CMDQ_CODE_WRITE_S = 0x90, 64 CMDQ_CODE_WRITE_S_MASK = 0x91, 65 CMDQ_CODE_LOGIC = 0xa0, 66 }; 67 68 struct cmdq_cb_data { 69 int sta; 70 struct cmdq_pkt *pkt; 71 }; 72 73 struct cmdq_mbox_priv { 74 u8 shift_pa; 75 dma_addr_t mminfra_offset; 76 }; 77 78 struct cmdq_pkt { 79 void *va_base; 80 dma_addr_t pa_base; 81 size_t cmd_buf_size; /* command occupied size */ 82 size_t buf_size; /* real buffer size */ 83 struct cmdq_mbox_priv priv; /* for generating instruction */ 84 }; 85 86 /** 87 * cmdq_get_mbox_priv() - get the private data of mailbox channel 88 * @chan: mailbox channel 89 * @priv: pointer to store the private data of mailbox channel 90 * 91 * While generating the GCE instruction to command buffer, the private data 92 * of GCE hardware may need to be referenced, such as the shift bits of 93 * physical address. 94 * 95 * This function should be called before generating the GCE instruction. 96 */ 97 void cmdq_get_mbox_priv(struct mbox_chan *chan, struct cmdq_mbox_priv *priv); 98 99 /** 100 * cmdq_get_shift_pa() - get the shift bits of physical address 101 * @chan: mailbox channel 102 * 103 * GCE can only fetch the command buffer address from a 32-bit register. 104 * Some SOCs support more than 32-bit command buffer address for GCE, which 105 * requires some shift bits to make the address fit into the 32-bit register. 106 * 107 * Return: the shift bits of physical address 108 */ 109 u8 cmdq_get_shift_pa(struct mbox_chan *chan); 110 111 #endif /* __MTK_CMDQ_MAILBOX_H__ */ 112