soc: mediatek: mtk-cmdq: Extend cmdq_pkt_write API for SoCs without subsys ID

This patch extends the cmdq_pkt_write API to support SoCs that do not
have subsys ID mapping by introducing new register write APIs:
- cmdq_pkt_write_pa() and cmdq_pkt_write_subsys() replace
  cmdq_pkt_write()
- cmdq_pkt_write_mask_pa() and cmdq_pkt_write_mask_subsys() replace
  cmdq_pkt_write_mask()

To ensure consistent function pointer interfaces, both
cmdq_pkt_write_pa() and cmdq_pkt_write_subsys() provide subsys and
pa_base parameters. This unifies how register writes are invoked,
regardless of whether subsys ID is supported by the device.

All GCEs support writing registers by PA (with mask) without subsys,
but this requires extra GCE instructions to convert the PA into a GCE
readable format, reducing performance compared to using subsys directly.
Therefore, subsys is preferred for register writes when available.

API documentation and function pointer declarations in cmdq_client_reg
have been updated. The original write APIs will be removed after all
CMDQ users transition to the new interfaces.

Signed-off-by: Jason-JH Lin <jason-jh.lin@mediatek.com>
Reviewed-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
Acked-by: Jassi Brar <jassisinghbrar@gmail.com>
Acked-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>

diff --git a/drivers/soc/mediatek/mtk-cmdq-helper.c b/drivers/soc/mediatek/mtk-cmdq-helper.c
index 80806fbeba918ea54e1aa6487f7661e19598fb1a..b30715ef0d6f2cccf403720576e05e3c6027c66c 100644 (file)
--- a/drivers/soc/mediatek/mtk-cmdq-helper.c
+++ b/drivers/soc/mediatek/mtk-cmdq-helper.c
@@ -85,6 +85,16 @@ int cmdq_dev_get_client_reg(struct device *dev,
                /* make subsys invalid */
                client_reg->subsys = CMDQ_SUBSYS_INVALID;
 
+               /*
+                * All GCEs support writing register PA with mask without subsys,
+                * but this requires extra GCE instructions to convert the PA into
+                * a format that GCE can handle, which is less performance than
+                * directly using subsys. Therefore, when subsys is available,
+                * we prefer to use subsys for writing register PA.
+                */
+               client_reg->pkt_write = cmdq_pkt_write_pa;
+               client_reg->pkt_write_mask = cmdq_pkt_write_mask_pa;
+
                return 0;
        }
 
@@ -93,6 +103,9 @@ int cmdq_dev_get_client_reg(struct device *dev,
        client_reg->size = (u16)spec.args[2];
        of_node_put(spec.np);
 
+       client_reg->pkt_write = cmdq_pkt_write_subsys;
+       client_reg->pkt_write_mask = cmdq_pkt_write_mask_subsys;
+
        return 0;
 }
 EXPORT_SYMBOL(cmdq_dev_get_client_reg);
@@ -214,6 +227,26 @@ int cmdq_pkt_write(struct cmdq_pkt *pkt, u8 subsys, u16 offset, u32 value)
 }
 EXPORT_SYMBOL(cmdq_pkt_write);
 
+int cmdq_pkt_write_pa(struct cmdq_pkt *pkt, u8 subsys /*unused*/, u32 pa_base,
+                     u16 offset, u32 value)
+{
+       int err;
+
+       err = cmdq_pkt_assign(pkt, CMDQ_THR_SPR_IDX0, CMDQ_ADDR_HIGH(pa_base));
+       if (err < 0)
+               return err;
+
+       return cmdq_pkt_write_s_value(pkt, CMDQ_THR_SPR_IDX0, CMDQ_ADDR_LOW(offset), value);
+}
+EXPORT_SYMBOL(cmdq_pkt_write_pa);
+
+int cmdq_pkt_write_subsys(struct cmdq_pkt *pkt, u8 subsys, u32 pa_base /*unused*/,
+                         u16 offset, u32 value)
+{
+       return cmdq_pkt_write(pkt, subsys, offset, value);
+}
+EXPORT_SYMBOL(cmdq_pkt_write_subsys);
+
 int cmdq_pkt_write_mask(struct cmdq_pkt *pkt, u8 subsys,
                        u16 offset, u32 value, u32 mask)
 {
@@ -231,6 +264,27 @@ int cmdq_pkt_write_mask(struct cmdq_pkt *pkt, u8 subsys,
 }
 EXPORT_SYMBOL(cmdq_pkt_write_mask);
 
+int cmdq_pkt_write_mask_pa(struct cmdq_pkt *pkt, u8 subsys /*unused*/, u32 pa_base,
+                          u16 offset, u32 value, u32 mask)
+{
+       int err;
+
+       err = cmdq_pkt_assign(pkt, CMDQ_THR_SPR_IDX0, CMDQ_ADDR_HIGH(pa_base));
+       if (err < 0)
+               return err;
+
+       return cmdq_pkt_write_s_mask_value(pkt, CMDQ_THR_SPR_IDX0,
+                                          CMDQ_ADDR_LOW(offset), value, mask);
+}
+EXPORT_SYMBOL(cmdq_pkt_write_mask_pa);
+
+int cmdq_pkt_write_mask_subsys(struct cmdq_pkt *pkt, u8 subsys, u32 pa_base /*unused*/,
+                              u16 offset, u32 value, u32 mask)
+{
+       return cmdq_pkt_write_mask(pkt, subsys, offset, value, mask);
+}
+EXPORT_SYMBOL(cmdq_pkt_write_mask_subsys);
+
 int cmdq_pkt_read_s(struct cmdq_pkt *pkt, u16 high_addr_reg_idx, u16 addr_low,
                    u16 reg_idx)
 {

diff --git a/include/linux/soc/mediatek/mtk-cmdq.h b/include/linux/soc/mediatek/mtk-cmdq.h
index 3578cc9200e96abb8b2ec127f1d959719f981e2c..a06b5a61f337580bf176b1b3ff797f9822e6efef 100644 (file)
--- a/include/linux/soc/mediatek/mtk-cmdq.h
+++ b/include/linux/soc/mediatek/mtk-cmdq.h
@@ -57,6 +57,17 @@ struct cmdq_client_reg {
        phys_addr_t pa_base;
        u16 offset;
        u16 size;
+
+       /*
+        * Client only uses these functions for MMIO access,
+        * so doesn't need to handle the mminfra_offset.
+        * The mminfra_offset is used for DRAM access and
+        * is handled internally by CMDQ APIs.
+        */
+       int (*pkt_write)(struct cmdq_pkt *pkt, u8 subsys, u32 pa_base,
+                        u16 offset, u32 value);
+       int (*pkt_write_mask)(struct cmdq_pkt *pkt, u8 subsys, u32 pa_base,
+                             u16 offset, u32 value, u32 mask);
 };
 
 struct cmdq_client {
@@ -124,6 +135,32 @@ void cmdq_pkt_destroy(struct cmdq_client *client, struct cmdq_pkt *pkt);
  */
 int cmdq_pkt_write(struct cmdq_pkt *pkt, u8 subsys, u16 offset, u32 value);
 
+/**
+ * cmdq_pkt_write_pa() - append write command to the CMDQ packet with pa_base
+ * @pkt:       the CMDQ packet
+ * @subsys:    unused parameter
+ * @pa_base:   the physical address base of the hardware register
+ * @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_pa(struct cmdq_pkt *pkt, u8 subsys /*unused*/,
+                     u32 pa_base, u16 offset, u32 value);
+
+/**
+ * cmdq_pkt_write_subsys() - append write command to the CMDQ packet with subsys
+ * @pkt:       the CMDQ packet
+ * @subsys:    the CMDQ sub system code
+ * @pa_base:   unused parameter
+ * @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_subsys(struct cmdq_pkt *pkt, u8 subsys,
+                         u32 pa_base /*unused*/, u16 offset, u32 value);
+
 /**
  * cmdq_pkt_write_mask() - append write command with mask to the CMDQ packet
  * @pkt:       the CMDQ packet
@@ -137,6 +174,34 @@ int cmdq_pkt_write(struct cmdq_pkt *pkt, u8 subsys, u16 offset, u32 value);
 int cmdq_pkt_write_mask(struct cmdq_pkt *pkt, u8 subsys,
                        u16 offset, u32 value, u32 mask);
 
+/**
+ * cmdq_pkt_write_mask_pa() - append write command with mask to the CMDQ packet with pa
+ * @pkt:       the CMDQ packet
+ * @subsys:    unused parameter
+ * @pa_base:   the physical address base of the hardware register
+ * @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_pa(struct cmdq_pkt *pkt, u8 subsys /*unused*/,
+                          u32 pa_base, u16 offset, u32 value, u32 mask);
+
+/**
+ * cmdq_pkt_write_mask_subsys() - append write command with mask to the CMDQ packet with subsys
+ * @pkt:       the CMDQ packet
+ * @subsys:    the CMDQ sub system code
+ * @pa_base:   unused parameter
+ * @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_subsys(struct cmdq_pkt *pkt, u8 subsys,
+                              u32 pa_base /*unused*/, u16 offset, u32 value, u32 mask);
+
 /*
  * cmdq_pkt_read_s() - append read_s command to the CMDQ packet
  * @pkt:       the CMDQ packet
@@ -421,12 +486,37 @@ static inline int cmdq_pkt_write(struct cmdq_pkt *pkt, u8 subsys, u16 offset, u3
        return -ENOENT;
 }
 
+static inline int cmdq_pkt_write_pa(struct cmdq_pkt *pkt, u8 subsys /*unused*/,
+                                   u32 pa_base, u16 offset, u32 value)
+{
+       return -ENOENT;
+}
+
+static inline int cmdq_pkt_write_subsys(struct cmdq_pkt *pkt, u8 subsys,
+                                       u32 pa_base /*unused*/, u16 offset, u32 value)
+{
+       return -ENOENT;
+}
+
 static inline int cmdq_pkt_write_mask(struct cmdq_pkt *pkt, u8 subsys,
                                      u16 offset, u32 value, u32 mask)
 {
        return -ENOENT;
 }
 
+static inline int cmdq_pkt_write_mask_pa(struct cmdq_pkt *pkt, u8 subsys /*unused*/,
+                                        u32 pa_base, u16 offset, u32 value, u32 mask)
+{
+       return -ENOENT;
+}
+
+static inline int cmdq_pkt_write_mask_subsys(struct cmdq_pkt *pkt, u8 subsys,
+                                            u32 pa_base /*unused*/, u16 offset,
+                                            u32 value, u32 mask)
+{
+       return -ENOENT;
+}
+
 static inline int cmdq_pkt_read_s(struct cmdq_pkt *pkt, u16 high_addr_reg_idx,
                                  u16 addr_low, u16 reg_idx)
 {