1 /*
2  * Copyright (c) 2022-2023, NXP
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  */
6 
7 #ifndef ZEPHYR_SOC_ARM64_NXP_IMX9_PINCTRL_SOC_H_
8 #define ZEPHYR_SOC_ARM64_NXP_IMX9_PINCTRL_SOC_H_
9 
10 #include <zephyr/devicetree.h>
11 #include <zephyr/types.h>
12 #include "fsl_common.h"
13 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
18 #define MCUX_IMX_INPUT_SCHMITT_ENABLE_SHIFT IOMUXC1_SW_PAD_CTL_PAD_HYS_SHIFT
19 #define MCUX_IMX_DRIVE_OPEN_DRAIN_SHIFT     IOMUXC1_SW_PAD_CTL_PAD_OD_SHIFT
20 #define MCUX_IMX_BIAS_PULL_DOWN_SHIFT       IOMUXC1_SW_PAD_CTL_PAD_PD_SHIFT
21 #define MCUX_IMX_BIAS_PULL_UP_SHIFT         IOMUXC1_SW_PAD_CTL_PAD_PU_SHIFT
22 #define MCUX_IMX_SLEW_RATE_SHIFT            IOMUXC1_SW_PAD_CTL_PAD_FSEL1_SHIFT
23 #define MCUX_IMX_DRIVE_STRENGTH_SHIFT       IOMUXC1_SW_PAD_CTL_PAD_DSE_SHIFT
24 #define MCUX_IMX_INPUT_ENABLE_SHIFT         23 /* Shift to a bit not used by IOMUXC_SW_PAD_CTL */
25 #define MCUX_IMX_INPUT_ENABLE(x)            ((x >> MCUX_IMX_INPUT_ENABLE_SHIFT) & 0x1)
26 
27 #define Z_PINCTRL_MCUX_IMX_PINCFG_INIT(node_id)                                                    \
28 	((DT_PROP(node_id, input_schmitt_enable) << MCUX_IMX_INPUT_SCHMITT_ENABLE_SHIFT) |         \
29 	 (DT_PROP(node_id, drive_open_drain) << MCUX_IMX_DRIVE_OPEN_DRAIN_SHIFT) |                 \
30 	 (DT_PROP(node_id, bias_pull_down) << MCUX_IMX_BIAS_PULL_DOWN_SHIFT) |                     \
31 	 (DT_PROP(node_id, bias_pull_up) << MCUX_IMX_BIAS_PULL_UP_SHIFT) |                         \
32 	 (DT_ENUM_IDX(node_id, slew_rate) << MCUX_IMX_SLEW_RATE_SHIFT) |                           \
33 	 ((~(0xff << DT_ENUM_IDX(node_id, drive_strength))) << MCUX_IMX_DRIVE_STRENGTH_SHIFT) |    \
34 	 (DT_PROP(node_id, input_enable) << MCUX_IMX_INPUT_ENABLE_SHIFT))
35 
36 /* This struct must be present. It is used by the mcux gpio driver */
37 struct pinctrl_soc_pinmux {
38 	uint32_t mux_register;    /*!< IOMUXC SW_PAD_MUX register */
39 	uint32_t config_register; /*!< IOMUXC SW_PAD_CTL register */
40 	uint32_t input_register;  /*!< IOMUXC SELECT_INPUT DAISY register */
41 	uint8_t mux_mode: 4;      /*!< Mux value for SW_PAD_MUX register */
42 	uint32_t input_daisy: 4;  /*!< Mux value for SELECT_INPUT_DAISY register */
43 };
44 
45 struct pinctrl_soc_pin {
46 	struct pinctrl_soc_pinmux pinmux;
47 	uint32_t pin_ctrl_flags; /*!< value to write to IOMUXC_SW_PAD_CTL register */
48 };
49 
50 typedef struct pinctrl_soc_pin pinctrl_soc_pin_t;
51 
52 /* This definition must be present. It is used by the mcux gpio driver */
53 #define MCUX_IMX_PINMUX(node_id)                                                                   \
54 	{                                                                                          \
55 		.mux_register = DT_PROP_BY_IDX(node_id, pinmux, 0),                                \
56 		.config_register = DT_PROP_BY_IDX(node_id, pinmux, 4),                             \
57 		.input_register = DT_PROP_BY_IDX(node_id, pinmux, 2),                              \
58 		.mux_mode = DT_PROP_BY_IDX(node_id, pinmux, 1),                                    \
59 		.input_daisy = DT_PROP_BY_IDX(node_id, pinmux, 3),                                 \
60 	}
61 
62 #define Z_PINCTRL_PINMUX(group_id, pin_prop, idx)                                                  \
63 	MCUX_IMX_PINMUX(DT_PHANDLE_BY_IDX(group_id, pin_prop, idx))
64 
65 #define Z_PINCTRL_STATE_PIN_INIT(group_id, pin_prop, idx)                                          \
66 	{                                                                                          \
67 		.pinmux = Z_PINCTRL_PINMUX(group_id, pin_prop, idx),                               \
68 		.pin_ctrl_flags = Z_PINCTRL_MCUX_IMX_PINCFG_INIT(group_id),                        \
69 	},
70 
71 #define Z_PINCTRL_STATE_PINS_INIT(node_id, prop)                                                   \
72 	{DT_FOREACH_CHILD_VARGS(DT_PHANDLE(node_id, prop), DT_FOREACH_PROP_ELEM, pinmux,           \
73 				Z_PINCTRL_STATE_PIN_INIT)};
74 
75 #ifdef __cplusplus
76 }
77 #endif
78 
79 #endif /* ZEPHYR_SOC_ARM64_NXP_IMX9_PINCTRL_SOC_H_ */
80