1 /* SPDX-License-Identifier: BSD-3-Clause */ 2 /* 3 * Copyright (c) 2021 Rockchip Electronics Co., Ltd. 4 */ 5 6 #include "hal_base.h" 7 8 #if defined(HAL_PINCTRL_MODULE_ENABLED) 9 10 /** @addtogroup RK_HAL_Driver 11 * @{ 12 */ 13 14 /** @addtogroup PINCTRL 15 * @{ 16 */ 17 18 /** @defgroup PINCTRL_How_To_Sel_IO_Func How To Select IO Function 19 * @{ 20 21 APIs support to set iomux route mode to m0,m1,... 22 23 HAL_PINCTRL_IOFuncSelFor<MODULE>(mode) 24 25 MODULE support list: 26 27 CIF EMMC FLASH FSPI LCDC MIPICSI RGMII SDIO SDMMC0 28 CAN0 CAN1 CAN2 CAN3 CAN4 CAN5 29 I2C0 I2C1 I2C2 I2C3 I2C4 I2C5 30 I2S0 I2S1 I2S2 31 SPI0 SPI1 SPI2 SPI3 SPI4 SPI5 32 PWM0 PWM1 ... PWM11 33 UART0 UART1 ... UART11 34 35 examples: 36 37 HAL_PINCTRL_IOFuncSelForCAN0(IOFUNC_SEL_M0) 38 HAL_PINCTRL_IOFuncSelForCIF(IOFUNC_SEL_M0) 39 HAL_PINCTRL_IOFuncSelForMIPICSI(IOFUNC_SEL_M1) 40 HAL_PINCTRL_IOFuncSelForI2C0(IOFUNC_SEL_M2) 41 @} */ 42 43 /** @defgroup PINCTRL_Private_Definition Private Definition 44 * @{ 45 */ 46 /********************* Private MACRO Definition ******************************/ 47 48 /* Basic Definitions */ 49 #define _CHECK(...) _CHECK_(__VA_ARGS__) 50 #define _CHECK_(a, b, ...) b 51 #define _IS_PAREN(x) _CHECK(_IS_PAREN_ x, 0) 52 #define _IS_PAREN_(...) 1, 1 53 #define _CONCAT(a, b) _CONCAT_(a, b) 54 #define _CONCAT_(a, b) a ## b 55 #define _DEF(x) _IS_PAREN(x) 56 57 /* IOFUNC Select Setting Definitions */ 58 #define _IOMUX_WRITE(REG, DATA, SHIFT, MASK) \ 59 { \ 60 HAL_ASSERT((uint32_t)((DATA) << (SHIFT)) <= (uint32_t)(MASK)); \ 61 HAL_DBG("PINCTRL Write before set reg val=0x%lx\n", REG); \ 62 REG = ((DATA) << (SHIFT)) | ((MASK) << 16); \ 63 HAL_DBG("PINCTRL Write after set reg val=0x%lx\n", REG); \ 64 ret = HAL_OK; \ 65 } 66 67 /* IOFUNC Select Basic Definition */ 68 #define S_DEF_IF_0(x, y, z) 69 #define S_DEF_IF_1(x, y, z) _IOMUX_WRITE(GRF->IOFUNC_SEL##x, z, GRF_IOFUNC_SEL##x##y##_IOMUX_SEL_SHIFT, GRF_IOFUNC_SEL##x##y##_IOMUX_SEL_MASK) 70 #define S_COND_DEF(x, y, z) _CONCAT(S_DEF_IF_, _DEF(GRF_IOFUNC_SEL##x##y##_IOMUX_SEL_MASK))(x, y, z) 71 #define C_DEF_IF_0(x, y, z) 72 #define C_DEF_IF_1(x, y, z) _IOMUX_WRITE(GRF->IOFUNC_CON##x, z, GRF_IOFUNC_CON##x##y##_IOMUX_SEL_SHIFT, GRF_IOFUNC_CON##x##y##_IOMUX_SEL_MASK) 73 #define C_COND_DEF(x, y, z) _CONCAT(C_DEF_IF_, _DEF(GRF_IOFUNC_CON##x##y##_IOMUX_SEL_MASK))(x, y, z) 74 75 /** 76 * @brief HAL IOMUX Select API Basic Definition 77 * 78 * IOMUX SEL should be defined by members of GRF structure 79 * IOFUNC_CON0 80 * IOFUNC_CON1 81 * IOFUNC_CON2 82 * IOFUNC_CON3 83 * IOFUNC_CON4 84 * IOFUNC_CON5 85 * IOFUNC_SEL0 86 * IOFUNC_SEL1 87 * IOFUNC_SEL2 88 * IOFUNC_SEL3 89 * IOFUNC_SEL4 90 * IOFUNC_SEL5 91 * 92 * The HAL_PINCTRL_IOFuncSelFor<Module> will try to find valid SHIFT and MASK definition in 93 * IOFUNC_CONx or IOFUNC_SELx 94 * 95 * SHIFT and MASK bits are defined in soc head file. 96 */ 97 #define DEFINE_IOMUX_FUNC(name) \ 98 HAL_Status HAL_PINCTRL_IOFuncSelFor##name(eIOFUNC_SEL m) \ 99 { \ 100 HAL_Status ret = HAL_ERROR; \ 101 S_COND_DEF(0, _##name, m) \ 102 S_COND_DEF(1, _##name, m) \ 103 S_COND_DEF(2, _##name, m) \ 104 S_COND_DEF(3, _##name, m) \ 105 S_COND_DEF(4, _##name, m) \ 106 S_COND_DEF(5, _##name, m) \ 107 C_COND_DEF(0, _##name, m) \ 108 C_COND_DEF(1, _##name, m) \ 109 C_COND_DEF(2, _##name, m) \ 110 C_COND_DEF(3, _##name, m) \ 111 C_COND_DEF(4, _##name, m) \ 112 C_COND_DEF(5, _##name, m) \ 113 HAL_ASSERT(ret != HAL_ERROR); \ 114 return ret; \ 115 } 116 117 DEFINE_IOMUX_FUNC(CIF) 118 DEFINE_IOMUX_FUNC(EMMC) 119 DEFINE_IOMUX_FUNC(FLASH) 120 DEFINE_IOMUX_FUNC(FSPI) 121 DEFINE_IOMUX_FUNC(LCDC) 122 DEFINE_IOMUX_FUNC(MIPICSI) 123 DEFINE_IOMUX_FUNC(RGMII) 124 DEFINE_IOMUX_FUNC(GMAC0) 125 DEFINE_IOMUX_FUNC(GMAC1) 126 DEFINE_IOMUX_FUNC(SDIO) 127 DEFINE_IOMUX_FUNC(SDMMC0) 128 129 DEFINE_IOMUX_FUNC(CAN0) 130 DEFINE_IOMUX_FUNC(CAN1) 131 DEFINE_IOMUX_FUNC(CAN2) 132 DEFINE_IOMUX_FUNC(CAN3) 133 DEFINE_IOMUX_FUNC(CAN4) 134 DEFINE_IOMUX_FUNC(CAN5) 135 DEFINE_IOMUX_FUNC(I2C0) 136 DEFINE_IOMUX_FUNC(I2C1) 137 DEFINE_IOMUX_FUNC(I2C2) 138 DEFINE_IOMUX_FUNC(I2C3) 139 DEFINE_IOMUX_FUNC(I2C4) 140 DEFINE_IOMUX_FUNC(I2C5) 141 DEFINE_IOMUX_FUNC(I2S0) 142 DEFINE_IOMUX_FUNC(I2S1) 143 DEFINE_IOMUX_FUNC(I2S2) 144 DEFINE_IOMUX_FUNC(PWM0) 145 DEFINE_IOMUX_FUNC(PWM1) 146 DEFINE_IOMUX_FUNC(PWM2) 147 DEFINE_IOMUX_FUNC(PWM3) 148 DEFINE_IOMUX_FUNC(PWM4) 149 DEFINE_IOMUX_FUNC(PWM5) 150 DEFINE_IOMUX_FUNC(PWM6) 151 DEFINE_IOMUX_FUNC(PWM7) 152 DEFINE_IOMUX_FUNC(PWM8) 153 DEFINE_IOMUX_FUNC(PWM9) 154 DEFINE_IOMUX_FUNC(PWM10) 155 DEFINE_IOMUX_FUNC(PWM11) 156 DEFINE_IOMUX_FUNC(SPI0) 157 DEFINE_IOMUX_FUNC(SPI1) 158 DEFINE_IOMUX_FUNC(SPI2) 159 DEFINE_IOMUX_FUNC(SPI3) 160 DEFINE_IOMUX_FUNC(SPI4) 161 DEFINE_IOMUX_FUNC(SPI5) 162 DEFINE_IOMUX_FUNC(UART0) 163 DEFINE_IOMUX_FUNC(UART1) 164 DEFINE_IOMUX_FUNC(UART2) 165 DEFINE_IOMUX_FUNC(UART3) 166 DEFINE_IOMUX_FUNC(UART4) 167 DEFINE_IOMUX_FUNC(UART5) 168 DEFINE_IOMUX_FUNC(UART6) 169 DEFINE_IOMUX_FUNC(UART7) 170 DEFINE_IOMUX_FUNC(UART8) 171 DEFINE_IOMUX_FUNC(UART9) 172 DEFINE_IOMUX_FUNC(UART10) 173 DEFINE_IOMUX_FUNC(UART11) 174 175 /** @} */ 176 177 /** @} */ 178 179 /** @} */ 180 181 #endif /* HAL_PINCTRL_MODULE_ENABLED */ 182