/* SPDX-License-Identifier: GPL-2.0 */ /* Copyright (c) 2015-2018, The Linux Foundation. All rights reserved. * Copyright (C) 2018-2023 Linaro Ltd. */ #ifndef _GSI_REG_H_ #define _GSI_REG_H_ /* === Only "gsi.c" and "gsi_reg.c" should include this file === */ #include struct platform_device; struct gsi; /** * DOC: GSI Registers * * GSI registers are located within the "gsi" address space defined by Device * Tree. The offset of each register within that space is specified by * symbols defined below. The GSI address space is mapped to virtual memory * space in gsi_init(). All GSI registers are 32 bits wide. * * Each register type is duplicated for a number of instances of something. * For example, each GSI channel has its own set of registers defining its * configuration. The offset to a channel's set of registers is computed * based on a "base" offset plus an additional "stride" amount computed * from the channel's ID. For such registers, the offset is computed by a * function-like macro that takes a parameter used in the computation. * * The offset of a register dependent on execution environment is computed * by a macro that is supplied a parameter "ee". The "ee" value is a member * of the gsi_ee_id enumerated type. * * The offset of a channel register is computed by a macro that is supplied a * parameter "ch". The "ch" value is a channel id whose maximum value is 30 * (though the actual limit is hardware-dependent). * * The offset of an event register is computed by a macro that is supplied a * parameter "ev". The "ev" value is an event id whose maximum value is 15 * (though the actual limit is hardware-dependent). */ /* enum gsi_reg_id - GSI register IDs */ enum gsi_reg_id { INTER_EE_SRC_CH_IRQ_MSK, /* IPA v3.5+ */ INTER_EE_SRC_EV_CH_IRQ_MSK, /* IPA v3.5+ */ CH_C_CNTXT_0, CH_C_CNTXT_1, CH_C_CNTXT_2, CH_C_CNTXT_3, CH_C_QOS, CH_C_SCRATCH_0, CH_C_SCRATCH_1, CH_C_SCRATCH_2, CH_C_SCRATCH_3, EV_CH_E_CNTXT_0, EV_CH_E_CNTXT_1, EV_CH_E_CNTXT_2, EV_CH_E_CNTXT_3, EV_CH_E_CNTXT_4, EV_CH_E_CNTXT_8, EV_CH_E_CNTXT_9, EV_CH_E_CNTXT_10, EV_CH_E_CNTXT_11, EV_CH_E_CNTXT_12, EV_CH_E_CNTXT_13, EV_CH_E_SCRATCH_0, EV_CH_E_SCRATCH_1, CH_C_DOORBELL_0, EV_CH_E_DOORBELL_0, GSI_STATUS, CH_CMD, EV_CH_CMD, GENERIC_CMD, HW_PARAM_2, /* IPA v3.5.1+ */ HW_PARAM_4, /* IPA v5.0+ */ CNTXT_TYPE_IRQ, CNTXT_TYPE_IRQ_MSK, CNTXT_SRC_CH_IRQ, CNTXT_SRC_CH_IRQ_MSK, CNTXT_SRC_CH_IRQ_CLR, CNTXT_SRC_EV_CH_IRQ, CNTXT_SRC_EV_CH_IRQ_MSK, CNTXT_SRC_EV_CH_IRQ_CLR, CNTXT_SRC_IEOB_IRQ, CNTXT_SRC_IEOB_IRQ_MSK, CNTXT_SRC_IEOB_IRQ_CLR, CNTXT_GLOB_IRQ_STTS, CNTXT_GLOB_IRQ_EN, CNTXT_GLOB_IRQ_CLR, CNTXT_GSI_IRQ_STTS, CNTXT_GSI_IRQ_EN, CNTXT_GSI_IRQ_CLR, CNTXT_INTSET, ERROR_LOG, ERROR_LOG_CLR, CNTXT_SCRATCH_0, GSI_REG_ID_COUNT, /* Last; not an ID */ }; /* CH_C_CNTXT_0 register */ enum gsi_reg_ch_c_cntxt_0_field_id { CHTYPE_PROTOCOL, CHTYPE_DIR, CH_EE, CHID, CHTYPE_PROTOCOL_MSB, /* IPA v4.5-4.11 */ ERINDEX, /* Not IPA v5.0+ */ CHSTATE, ELEMENT_SIZE, }; /** enum gsi_channel_type - CHTYPE_PROTOCOL field values in CH_C_CNTXT_0 */ enum gsi_channel_type { GSI_CHANNEL_TYPE_MHI = 0x0, GSI_CHANNEL_TYPE_XHCI = 0x1, GSI_CHANNEL_TYPE_GPI = 0x2, GSI_CHANNEL_TYPE_XDCI = 0x3, GSI_CHANNEL_TYPE_WDI2 = 0x4, GSI_CHANNEL_TYPE_GCI = 0x5, GSI_CHANNEL_TYPE_WDI3 = 0x6, GSI_CHANNEL_TYPE_MHIP = 0x7, GSI_CHANNEL_TYPE_AQC = 0x8, GSI_CHANNEL_TYPE_11AD = 0x9, }; /* CH_C_CNTXT_1 register */ enum gsi_reg_ch_c_cntxt_1_field_id { CH_R_LENGTH, CH_ERINDEX, /* IPA v5.0+ */ }; /* CH_C_QOS register */ enum gsi_reg_ch_c_qos_field_id { WRR_WEIGHT, MAX_PREFETCH, USE_DB_ENG, USE_ESCAPE_BUF_ONLY, /* IPA v4.0-4.2 */ PREFETCH_MODE, /* IPA v4.5+ */ EMPTY_LVL_THRSHOLD, /* IPA v4.5+ */ DB_IN_BYTES, /* IPA v4.9+ */ LOW_LATENCY_EN, /* IPA v5.0+ */ }; /** enum gsi_prefetch_mode - PREFETCH_MODE field in CH_C_QOS */ enum gsi_prefetch_mode { USE_PREFETCH_BUFS = 0, ESCAPE_BUF_ONLY = 1, SMART_PREFETCH = 2, FREE_PREFETCH = 3, }; /* EV_CH_E_CNTXT_0 register */ enum gsi_reg_ch_c_ev_ch_e_cntxt_0_field_id { EV_CHTYPE, /* enum gsi_channel_type */ EV_EE, /* enum gsi_ee_id; always GSI_EE_AP for us */ EV_EVCHID, EV_INTYPE, EV_CHSTATE, EV_ELEMENT_SIZE, }; /* EV_CH_E_CNTXT_1 register */ enum gsi_reg_ev_ch_c_cntxt_1_field_id { R_LENGTH, }; /* EV_CH_E_CNTXT_8 register */ enum gsi_reg_ch_c_ev_ch_e_cntxt_8_field_id { EV_MODT, EV_MODC, EV_MOD_CNT, }; /* GSI_STATUS register */ enum gsi_reg_gsi_status_field_id { ENABLED, }; /* CH_CMD register */ enum gsi_reg_gsi_ch_cmd_field_id { CH_CHID, CH_OPCODE, }; /** enum gsi_ch_cmd_opcode - CH_OPCODE field values in CH_CMD */ enum gsi_ch_cmd_opcode { GSI_CH_ALLOCATE = 0x0, GSI_CH_START = 0x1, GSI_CH_STOP = 0x2, GSI_CH_RESET = 0x9, GSI_CH_DE_ALLOC = 0xa, GSI_CH_DB_STOP = 0xb, }; /* EV_CH_CMD register */ enum gsi_ev_ch_cmd_field_id { EV_CHID, EV_OPCODE, }; /** enum gsi_evt_cmd_opcode - EV_OPCODE field values in EV_CH_CMD */ enum gsi_evt_cmd_opcode { GSI_EVT_ALLOCATE = 0x0, GSI_EVT_RESET = 0x9, GSI_EVT_DE_ALLOC = 0xa, }; /* GENERIC_CMD register */ enum gsi_generic_cmd_field_id { GENERIC_OPCODE, GENERIC_CHID, GENERIC_EE, GENERIC_PARAMS, /* IPA v4.11+ */ }; /** enum gsi_generic_cmd_opcode - GENERIC_OPCODE field values in GENERIC_CMD */ enum gsi_generic_cmd_opcode { GSI_GENERIC_HALT_CHANNEL = 0x1, GSI_GENERIC_ALLOCATE_CHANNEL = 0x2, GSI_GENERIC_ENABLE_FLOW_CONTROL = 0x3, /* IPA v4.2+ */ GSI_GENERIC_DISABLE_FLOW_CONTROL = 0x4, /* IPA v4.2+ */ GSI_GENERIC_QUERY_FLOW_CONTROL = 0x5, /* IPA v4.11+ */ }; /* HW_PARAM_2 register */ /* IPA v3.5.1+ */ enum gsi_hw_param_2_field_id { IRAM_SIZE, NUM_CH_PER_EE, NUM_EV_PER_EE, /* Not IPA v5.0+ */ GSI_CH_PEND_TRANSLATE, GSI_CH_FULL_LOGIC, GSI_USE_SDMA, /* IPA v4.0+ */ GSI_SDMA_N_INT, /* IPA v4.0+ */ GSI_SDMA_MAX_BURST, /* IPA v4.0+ */ GSI_SDMA_N_IOVEC, /* IPA v4.0+ */ GSI_USE_RD_WR_ENG, /* IPA v4.2+ */ GSI_USE_INTER_EE, /* IPA v4.2+ */ }; /** enum gsi_iram_size - IRAM_SIZE field values in HW_PARAM_2 */ enum gsi_iram_size { IRAM_SIZE_ONE_KB = 0x0, IRAM_SIZE_TWO_KB = 0x1, /* The next two values are available for IPA v4.0 and above */ IRAM_SIZE_TWO_N_HALF_KB = 0x2, IRAM_SIZE_THREE_KB = 0x3, /* The next two values are available for IPA v4.5 and above */ IRAM_SIZE_THREE_N_HALF_KB = 0x4, IRAM_SIZE_FOUR_KB = 0x5, }; /* HW_PARAM_4 register */ /* IPA v5.0+ */ enum gsi_hw_param_4_field_id { EV_PER_EE, IRAM_PROTOCOL_COUNT, }; /** * enum gsi_irq_type_id: GSI IRQ types * @GSI_CH_CTRL: Channel allocation, deallocation, etc. * @GSI_EV_CTRL: Event ring allocation, deallocation, etc. * @GSI_GLOB_EE: Global/general event * @GSI_IEOB: Transfer (TRE) completion * @GSI_INTER_EE_CH_CTRL: Remote-issued stop/reset (unused) * @GSI_INTER_EE_EV_CTRL: Remote-issued event reset (unused) * @GSI_GENERAL: General hardware event (bus error, etc.) */ enum gsi_irq_type_id { GSI_CH_CTRL = BIT(0), GSI_EV_CTRL = BIT(1), GSI_GLOB_EE = BIT(2), GSI_IEOB = BIT(3), GSI_INTER_EE_CH_CTRL = BIT(4), GSI_INTER_EE_EV_CTRL = BIT(5), GSI_GENERAL = BIT(6), /* IRQ types 7-31 (and their bit values) are reserved */ }; /** enum gsi_global_irq_id: Global GSI interrupt events */ enum gsi_global_irq_id { ERROR_INT = BIT(0), GP_INT1 = BIT(1), GP_INT2 = BIT(2), GP_INT3 = BIT(3), /* Global IRQ types 4-31 (and their bit values) are reserved */ }; /** enum gsi_general_irq_id: GSI general IRQ conditions */ enum gsi_general_irq_id { BREAK_POINT = BIT(0), BUS_ERROR = BIT(1), CMD_FIFO_OVRFLOW = BIT(2), MCS_STACK_OVRFLOW = BIT(3), /* General IRQ types 4-31 (and their bit values) are reserved */ }; /* CNTXT_INTSET register */ enum gsi_cntxt_intset_field_id { INTYPE, }; /* ERROR_LOG register */ enum gsi_error_log_field_id { ERR_ARG3, ERR_ARG2, ERR_ARG1, ERR_CODE, ERR_VIRT_IDX, ERR_TYPE, ERR_EE, }; /** enum gsi_err_code - ERR_CODE field values in EE_ERR_LOG */ enum gsi_err_code { GSI_INVALID_TRE = 0x1, GSI_OUT_OF_BUFFERS = 0x2, GSI_OUT_OF_RESOURCES = 0x3, GSI_UNSUPPORTED_INTER_EE_OP = 0x4, GSI_EVT_RING_EMPTY = 0x5, GSI_NON_ALLOCATED_EVT_ACCESS = 0x6, /* 7 is not assigned */ GSI_HWO_1 = 0x8, }; /** enum gsi_err_type - ERR_TYPE field values in EE_ERR_LOG */ enum gsi_err_type { GSI_ERR_TYPE_GLOB = 0x1, GSI_ERR_TYPE_CHAN = 0x2, GSI_ERR_TYPE_EVT = 0x3, }; /* CNTXT_SCRATCH_0 register */ enum gsi_cntxt_scratch_0_field_id { INTER_EE_RESULT, GENERIC_EE_RESULT, }; /** enum gsi_generic_ee_result - GENERIC_EE_RESULT field values in SCRATCH_0 */ enum gsi_generic_ee_result { GENERIC_EE_SUCCESS = 0x1, GENERIC_EE_INCORRECT_CHANNEL_STATE = 0x2, GENERIC_EE_INCORRECT_DIRECTION = 0x3, GENERIC_EE_INCORRECT_CHANNEL_TYPE = 0x4, GENERIC_EE_INCORRECT_CHANNEL = 0x5, GENERIC_EE_RETRY = 0x6, GENERIC_EE_NO_RESOURCES = 0x7, }; extern const struct regs gsi_regs_v3_1; extern const struct regs gsi_regs_v3_5_1; extern const struct regs gsi_regs_v4_0; extern const struct regs gsi_regs_v4_5; extern const struct regs gsi_regs_v4_9; extern const struct regs gsi_regs_v4_11; /** * gsi_reg() - Return the structure describing a GSI register * @gsi: GSI pointer * @reg_id: GSI register ID */ const struct reg *gsi_reg(struct gsi *gsi, enum gsi_reg_id reg_id); /** * gsi_reg_init() - Perform GSI register initialization * @gsi: GSI pointer * @pdev: GSI (IPA) platform device * * Initialize GSI registers, including looking up and I/O mapping * the "gsi" memory space. */ int gsi_reg_init(struct gsi *gsi, struct platform_device *pdev); /** * gsi_reg_exit() - Inverse of gsi_reg_init() * @gsi: GSI pointer */ void gsi_reg_exit(struct gsi *gsi); #endif /* _GSI_REG_H_ */