관리-도구

편집 파일: mtk-cmdq.h

/* SPDX-License-Identifier: GPL-2.0 */ /* * Copyright (c) 2018 MediaTek Inc. * */ #ifndef __MTK_CMDQ_H__ #define __MTK_CMDQ_H__ #include <linux/mailbox_client.h> #include <linux/mailbox/mtk-cmdq-mailbox.h> #include <linux/timer.h> #define CMDQ_ADDR_HIGH(addr) ((u32)(((addr) >> 16) & GENMASK(31, 0))) #define CMDQ_ADDR_LOW(addr) ((u16)(addr) | BIT(1)) struct cmdq_pkt; struct cmdq_client_reg { u8 subsys; u16 offset; u16 size; }; struct cmdq_client { struct mbox_client client; struct mbox_chan *chan; }; /** * cmdq_dev_get_client_reg() - parse cmdq client reg from the device * node of CMDQ client * @dev: device of CMDQ mailbox client * @client_reg: CMDQ client reg pointer * @idx: the index of desired reg * * Return: 0 for success; else the error code is returned * * Help CMDQ client parsing the cmdq client reg * from the device node of CMDQ client. */ int cmdq_dev_get_client_reg(struct device *dev, struct cmdq_client_reg *client_reg, int idx); /** * cmdq_mbox_create() - create CMDQ mailbox client and channel * @dev: device of CMDQ mailbox client * @index: index of CMDQ mailbox channel * * Return: CMDQ mailbox client pointer */ struct cmdq_client *cmdq_mbox_create(struct device *dev, int index); /** * cmdq_mbox_destroy() - destroy CMDQ mailbox client and channel * @client: the CMDQ mailbox client */ void cmdq_mbox_destroy(struct cmdq_client *client); /** * cmdq_pkt_create() - create a CMDQ packet * @client: the CMDQ mailbox client * @size: required CMDQ buffer size * * Return: CMDQ packet pointer */ struct cmdq_pkt *cmdq_pkt_create(struct cmdq_client *client, size_t size); /** * cmdq_pkt_destroy() - destroy the CMDQ packet * @pkt: the CMDQ packet */ void cmdq_pkt_destroy(struct cmdq_pkt *pkt); /** * cmdq_pkt_write() - append write command to the CMDQ packet * @pkt: the CMDQ packet * @subsys: the CMDQ sub system code * @offset: register offset from CMDQ sub system * @value: the specified target register value * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_write(struct cmdq_pkt *pkt, u8 subsys, u16 offset, u32 value); /** * cmdq_pkt_write_mask() - append write command with mask to the CMDQ packet * @pkt: the CMDQ packet * @subsys: the CMDQ sub system code * @offset: register offset from CMDQ sub system * @value: the specified target register value * @mask: the specified target register mask * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_write_mask(struct cmdq_pkt *pkt, u8 subsys, u16 offset, u32 value, u32 mask); /* * cmdq_pkt_read_s() - append read_s command to the CMDQ packet * @pkt: the CMDQ packet * @high_addr_reg_idx: internal register ID which contains high address of pa * @addr_low: low address of pa * @reg_idx: the CMDQ internal register ID to cache read data * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_read_s(struct cmdq_pkt *pkt, u16 high_addr_reg_idx, u16 addr_low, u16 reg_idx); /** * cmdq_pkt_write_s() - append write_s command to the CMDQ packet * @pkt: the CMDQ packet * @high_addr_reg_idx: internal register ID which contains high address of pa * @addr_low: low address of pa * @src_reg_idx: the CMDQ internal register ID which cache source value * * Return: 0 for success; else the error code is returned * * Support write value to physical address without subsys. Use CMDQ_ADDR_HIGH() * to get high address and call cmdq_pkt_assign() to assign value into internal * reg. Also use CMDQ_ADDR_LOW() to get low address for addr_low parameter when * call to this function. */ int cmdq_pkt_write_s(struct cmdq_pkt *pkt, u16 high_addr_reg_idx, u16 addr_low, u16 src_reg_idx); /** * cmdq_pkt_write_s_mask() - append write_s with mask command to the CMDQ packet * @pkt: the CMDQ packet * @high_addr_reg_idx: internal register ID which contains high address of pa * @addr_low: low address of pa * @src_reg_idx: the CMDQ internal register ID which cache source value * @mask: the specified target address mask, use U32_MAX if no need * * Return: 0 for success; else the error code is returned * * Support write value to physical address without subsys. Use CMDQ_ADDR_HIGH() * to get high address and call cmdq_pkt_assign() to assign value into internal * reg. Also use CMDQ_ADDR_LOW() to get low address for addr_low parameter when * call to this function. */ int cmdq_pkt_write_s_mask(struct cmdq_pkt *pkt, u16 high_addr_reg_idx, u16 addr_low, u16 src_reg_idx, u32 mask); /** * cmdq_pkt_write_s_value() - append write_s command to the CMDQ packet which * write value to a physical address * @pkt: the CMDQ packet * @high_addr_reg_idx: internal register ID which contains high address of pa * @addr_low: low address of pa * @value: the specified target value * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_write_s_value(struct cmdq_pkt *pkt, u8 high_addr_reg_idx, u16 addr_low, u32 value); /** * cmdq_pkt_write_s_mask_value() - append write_s command with mask to the CMDQ * packet which write value to a physical * address * @pkt: the CMDQ packet * @high_addr_reg_idx: internal register ID which contains high address of pa * @addr_low: low address of pa * @value: the specified target value * @mask: the specified target mask * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_write_s_mask_value(struct cmdq_pkt *pkt, u8 high_addr_reg_idx, u16 addr_low, u32 value, u32 mask); /** * cmdq_pkt_wfe() - append wait for event command to the CMDQ packet * @pkt: the CMDQ packet * @event: the desired event type to wait * @clear: clear event or not after event arrive * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_wfe(struct cmdq_pkt *pkt, u16 event, bool clear); /** * cmdq_pkt_clear_event() - append clear event command to the CMDQ packet * @pkt: the CMDQ packet * @event: the desired event to be cleared * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_clear_event(struct cmdq_pkt *pkt, u16 event); /** * cmdq_pkt_set_event() - append set event command to the CMDQ packet * @pkt: the CMDQ packet * @event: the desired event to be set * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_set_event(struct cmdq_pkt *pkt, u16 event); /** * cmdq_pkt_poll() - Append polling command to the CMDQ packet, ask GCE to * execute an instruction that wait for a specified * hardware register to check for the value w/o mask. * All GCE hardware threads will be blocked by this * instruction. * @pkt: the CMDQ packet * @subsys: the CMDQ sub system code * @offset: register offset from CMDQ sub system * @value: the specified target register value * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_poll(struct cmdq_pkt *pkt, u8 subsys, u16 offset, u32 value); /** * cmdq_pkt_poll_mask() - Append polling command to the CMDQ packet, ask GCE to * execute an instruction that wait for a specified * hardware register to check for the value w/ mask. * All GCE hardware threads will be blocked by this * instruction. * @pkt: the CMDQ packet * @subsys: the CMDQ sub system code * @offset: register offset from CMDQ sub system * @value: the specified target register value * @mask: the specified target register mask * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_poll_mask(struct cmdq_pkt *pkt, u8 subsys, u16 offset, u32 value, u32 mask); /** * cmdq_pkt_assign() - Append logic assign command to the CMDQ packet, ask GCE * to execute an instruction that set a constant value into * internal register and use as value, mask or address in * read/write instruction. * @pkt: the CMDQ packet * @reg_idx: the CMDQ internal register ID * @value: the specified value * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_assign(struct cmdq_pkt *pkt, u16 reg_idx, u32 value); /** * cmdq_pkt_jump() - Append jump command to the CMDQ packet, ask GCE * to execute an instruction that change current thread PC to * a physical address which should contains more instruction. * @pkt: the CMDQ packet * @addr: physical address of target instruction buffer * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_jump(struct cmdq_pkt *pkt, dma_addr_t addr); /** * cmdq_pkt_finalize() - Append EOC and jump command to pkt. * @pkt: the CMDQ packet * * Return: 0 for success; else the error code is returned */ int cmdq_pkt_finalize(struct cmdq_pkt *pkt); /** * cmdq_pkt_flush_async() - trigger CMDQ to asynchronously execute the CMDQ * packet and call back at the end of done packet * @pkt: the CMDQ packet * @cb: called at the end of done packet * @data: this data will pass back to cb * * Return: 0 for success; else the error code is returned * * Trigger CMDQ to asynchronously execute the CMDQ packet and call back * at the end of done packet. Note that this is an ASYNC function. When the * function returned, it may or may not be finished. */ int cmdq_pkt_flush_async(struct cmdq_pkt *pkt, cmdq_async_flush_cb cb, void *data); #endif /* __MTK_CMDQ_H__ */