| /* |
| * Copyright (c) 2020 Nuvoton Technology Corporation. |
| * |
| * SPDX-License-Identifier: Apache-2.0 |
| */ |
| |
| #ifndef _NUVOTON_NPCX_SOC_DT_H_ |
| #define _NUVOTON_NPCX_SOC_DT_H_ |
| |
| #include <zephyr/devicetree.h> |
| #include <zephyr/irq.h> |
| #include <zephyr/sys/util_macro.h> |
| |
| /** |
| * @brief Like DT_PROP(), but expand parameters with |
| * DT_ENUM_UPPER_TOKEN not DT_PROP |
| * |
| * If the prop exists, this expands to DT_ENUM_UPPER_TOKEN(node_id, prop). |
| * The default_value parameter is not expanded in this case. |
| * |
| * Otherwise, this expands to default_value. |
| * |
| * @param node_id node identifier |
| * @param prop lowercase-and-underscores property name |
| * @param default_value a fallback value to expand to |
| * @return the property's enum upper token value or default_value |
| */ |
| #define NPCX_DT_PROP_ENUM_OR(node_id, prop, default_value) \ |
| COND_CODE_1(DT_NODE_HAS_PROP(node_id, prop), \ |
| (DT_STRING_UPPER_TOKEN(node_id, prop)), (default_value)) |
| |
| /** |
| * @brief Like DT_INST_PROP_OR(), but expand parameters with |
| * NPCX_DT_PROP_ENUM_OR not DT_PROP_OR |
| * @param inst instance number |
| * @param prop lowercase-and-underscores property name |
| * @param default_value a fallback value to expand to |
| * @return the property's enum upper token value or default_value |
| */ |
| #define NPCX_DT_INST_PROP_ENUM_OR(inst, prop, default_value) \ |
| NPCX_DT_PROP_ENUM_OR(DT_DRV_INST(inst), prop, default_value) |
| |
| /** |
| * @brief Construct a npcx_clk_cfg item from first item in 'clocks' prop which |
| * type is 'phandle-array' to handle "clock-cells" in current driver. |
| * |
| * Example devicetree fragment: |
| * / { |
| * uart1: serial@400c4000 { |
| * clocks = <&pcc NPCX_CLOCK_BUS_APB2 NPCX_PWDWN_CTL1 4>; |
| * ... |
| * }; |
| * }; |
| * |
| * Example usage: |
| * const struct npcx_clk_cfg clk_cfg = NPCX_DT_CLK_CFG_ITEM(inst); |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @return npcx_clk_cfg item. |
| */ |
| #define NPCX_DT_CLK_CFG_ITEM(inst) \ |
| { \ |
| .bus = NPCX_DT_INST_PROP_ENUM_OR(inst, clock_bus, \ |
| DT_PHA(DT_DRV_INST(inst), clocks, bus)), \ |
| .ctrl = DT_PHA(DT_DRV_INST(inst), clocks, ctl), \ |
| .bit = DT_PHA(DT_DRV_INST(inst), clocks, bit), \ |
| } |
| |
| /** |
| * @brief Construct a npcx_clk_cfg structure from 'clocks' property at index 'i' |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @param i index of clocks prop which type is 'phandle-array' |
| * @return npcx_clk_cfg item from 'clocks' property at index 'i' |
| */ |
| #define NPCX_DT_CLK_CFG_ITEM_BY_IDX(inst, i) \ |
| { \ |
| .bus = DT_CLOCKS_CELL_BY_IDX(DT_DRV_INST(inst), i, bus), \ |
| .ctrl = DT_CLOCKS_CELL_BY_IDX(DT_DRV_INST(inst), i, ctl), \ |
| .bit = DT_CLOCKS_CELL_BY_IDX(DT_DRV_INST(inst), i, bit), \ |
| } |
| |
| /** |
| * @brief Length of 'clocks' property which type is 'phandle-array' |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @return length of 'clocks' property which type is 'phandle-array' |
| */ |
| #define NPCX_DT_CLK_CFG_ITEMS_LEN(inst) DT_INST_PROP_LEN(inst, clocks) |
| |
| /** |
| * @brief Macro function to construct npcx_clk_cfg item in UTIL_LISTIFY |
| * extension. |
| * |
| * @param child child index in UTIL_LISTIFY extension. |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @return macro function to construct a npcx_clk_cfg structure. |
| */ |
| #define NPCX_DT_CLK_CFG_ITEMS_FUNC(child, inst) \ |
| NPCX_DT_CLK_CFG_ITEM_BY_IDX(inst, child) |
| |
| /** |
| * @brief Macro function to construct a list of npcx_clk_cfg items by |
| * UTIL_LISTIFY func |
| * |
| * Example devicetree fragment: |
| * / { |
| * host_sub: lpc@400c1000 { |
| * clocks = <&pcc NPCX_CLOCK_BUS_APB3 NPCX_PWDWN_CTL5 3>, |
| * <&pcc NPCX_CLOCK_BUS_APB3 NPCX_PWDWN_CTL5 4>, |
| * <&pcc NPCX_CLOCK_BUS_APB3 NPCX_PWDWN_CTL5 5>, |
| * <&pcc NPCX_CLOCK_BUS_APB3 NPCX_PWDWN_CTL5 6>, |
| * <&pcc NPCX_CLOCK_BUS_APB3 NPCX_PWDWN_CTL5 7>; |
| * ... |
| * }; |
| * Example usage: |
| * const struct npcx_clk_cfg clk_cfg[] = NPCX_DT_CLK_CFG_ITEMS_LIST(0); |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @return an array of npcx_clk_cfg items. |
| */ |
| #define NPCX_DT_CLK_CFG_ITEMS_LIST(inst) { \ |
| LISTIFY(NPCX_DT_CLK_CFG_ITEMS_LEN(inst), \ |
| NPCX_DT_CLK_CFG_ITEMS_FUNC, (,), \ |
| inst) \ |
| } |
| |
| /** |
| * @brief Construct a npcx_alt structure from 'pinctrl-0' property at index 'i' |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @param i index of 'pinctrl-0' prop which type is 'phandles' |
| * @return npcx_alt item from 'pinctrl-0' property at index 'i' |
| */ |
| #define NPCX_DT_ALT_ITEM_BY_IDX(inst, i) \ |
| { \ |
| .group = DT_PHA(DT_INST_PINCTRL_0(inst, i), alts, group), \ |
| .bit = DT_PHA(DT_INST_PINCTRL_0(inst, i), alts, bit), \ |
| .inverted = DT_PHA(DT_INST_PINCTRL_0(inst, i), alts, inv), \ |
| } |
| |
| /** |
| * @brief Macro function to construct npcx_alt item in UTIL_LISTIFY extension. |
| * |
| * @param child child index in UTIL_LISTIFY extension. |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @return macro function to construct a npcx_alt structure. |
| */ |
| #define NPCX_DT_ALT_ITEMS_FUNC(child, inst) NPCX_DT_ALT_ITEM_BY_IDX(inst, child) |
| |
| /** |
| * @brief Macro function to construct a list of npcx_alt items with compatible |
| * defined in DT_DRV_COMPAT by UTIL_LISTIFY func |
| * |
| * Example devicetree fragment: |
| * / { |
| * uart1: serial@400c4000 { |
| * pinctrl-0 = <&alta_uart1_sl1>; |
| * ... |
| * }; |
| * }; |
| * |
| * Example usage: |
| * const struct npcx_alt uart_alts[] = NPCX_DT_ALT_ITEMS_LIST(inst); |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @return an array of npcx_alt items. |
| */ |
| #define NPCX_DT_ALT_ITEMS_LIST(inst) { \ |
| LISTIFY(DT_INST_NUM_PINCTRLS_BY_IDX(inst, 0), \ |
| NPCX_DT_ALT_ITEMS_FUNC, (,), \ |
| inst) \ |
| } |
| |
| /** |
| * @brief Node identifier for an instance of a specific compatible |
| * |
| * @param compat specific compatible of devices in device-tree file |
| * @param inst instance number |
| * @return a node identifier for the node with "io_comp" compatible and |
| * instance number "inst" |
| */ |
| #define NPCX_DT_COMP_INST(compat, inst) DT_INST(inst, compat) |
| |
| /** |
| * @brief Get a specific compatible instance's node identifier for a phandle in |
| * a property. |
| * |
| * @param compat specific compatible of devices in device-tree file |
| * @param inst instance number |
| * @param prop lowercase-and-underscores property name in "inst" |
| * with type "phandle", "phandles" or "phandle-array" |
| * @param idx index into "prop" |
| * @return a node identifier for the phandle at index "idx" in "prop" |
| */ |
| #define NPCX_DT_COMP_INST_PHANDLE_BY_IDX(compat, inst, prop, idx) \ |
| DT_PHANDLE_BY_IDX(NPCX_DT_COMP_INST(compat, inst), prop, idx) |
| |
| /** |
| * @brief Get phandle from 'pinctrl-0' prop which type is 'phandles' at index |
| * 'i' from io-pads device with specific compatible. |
| * |
| * @param io_comp compatible string in devicetree file for io-pads device |
| * @param inst instance number for compatible defined in io_comp. |
| * @param i index of 'pinctrl-0' prop which type is 'phandles' |
| * @return phandle from 'pinctrl-0' prop at index 'i' |
| */ |
| #define NPCX_DT_IO_PHANDLE_FROM_PINCTRL(io_comp, inst, i) \ |
| DT_PINCTRL_BY_IDX(NPCX_DT_COMP_INST(io_comp, inst), 0, i) |
| |
| /** |
| * @brief Construct a npcx_alt structure from 'pinctrl-0' property at index 'i' |
| * from io-pads device with specific compatible. |
| * |
| * @param io_comp compatible string in devicetree file for io-pads device |
| * @param inst instance number for compatible defined in io_comp. |
| * @param i index of 'pinctrl-0' prop which type is 'phandles' |
| * @return npcx_alt item from 'pinctrl-0' property at index 'i' |
| */ |
| #define NPCX_DT_IO_ALT_ITEM_BY_IDX(io_comp, inst, i) \ |
| { \ |
| .group = DT_PHA(NPCX_DT_IO_PHANDLE_FROM_PINCTRL(io_comp, inst, i), \ |
| alts, group), \ |
| .bit = DT_PHA(NPCX_DT_IO_PHANDLE_FROM_PINCTRL(io_comp, inst, i), \ |
| alts, bit), \ |
| .inverted = DT_PHA(NPCX_DT_IO_PHANDLE_FROM_PINCTRL(io_comp, inst, i),\ |
| alts, inv), \ |
| } |
| |
| /** |
| * @brief Length of npcx_alt structures in 'pinctrl-0' property of specific |
| * compatible io-pads device |
| * |
| * @param io_comp compatible string in devicetree file for io-pads device |
| * @param inst instance number for compatible defined in io_comp. |
| * @return length of 'pinctrl-0' property which type is 'phandles' |
| */ |
| #define NPCX_DT_IO_ALT_ITEMS_LEN(io_comp, inst) \ |
| DT_NUM_PINCTRLS_BY_IDX(NPCX_DT_COMP_INST(io_comp, inst), 0) |
| |
| /** |
| * @brief Macro function to construct npcx_alt item with specific compatible |
| * string in UTIL_LISTIFY extension. |
| * |
| * @param child child index in UTIL_LISTIFY extension. |
| * @param inst instance number for compatible defined in io_comp. |
| * @param io_comp compatible string in devicetree file for io-pads device |
| * @return macro function to construct a npcx_alt structure. |
| */ |
| #define NPCX_DT_IO_ALT_ITEMS_FUNC(child, inst, io_comp) \ |
| NPCX_DT_IO_ALT_ITEM_BY_IDX(io_comp, inst, child) |
| |
| /** |
| * @brief Macro function to construct a list of npcx_alt items with specific |
| * compatible string by UTIL_LISTIFY func |
| * |
| * Example devicetree fragment: |
| * / { |
| * host_uart: io_host_uart { |
| * compatible = "nuvoton,npcx-host-uart"; |
| * |
| * pinctrl-0 = <&altb_rxd_sl &altb_txd_sl |
| * &altb_rts_sl &altb_cts_sl |
| * &altb_ri_sl &altb_dtr_bout_sl |
| * &altb_dcd_sl &altb_dsr_sl>; |
| * ... |
| * }; |
| * }; |
| * |
| * Example usage: |
| * const struct npcx_alt host_uart_alts[] = |
| * NPCX_DT_IO_ALT_ITEMS_LIST(nuvoton_npcx_host_uart, 0); |
| * @param io_comp compatible string in devicetree file for io-pads device |
| * @param inst instance number for compatible defined in io_comp. |
| * @return an array of npcx_alt items. |
| */ |
| #define NPCX_DT_IO_ALT_ITEMS_LIST(io_comp, inst) { \ |
| LISTIFY(NPCX_DT_IO_ALT_ITEMS_LEN(io_comp, inst), \ |
| NPCX_DT_IO_ALT_ITEMS_FUNC, (,), \ |
| inst, io_comp) \ |
| } |
| |
| /** |
| * @brief Get phandle from "name" property which contains wui information. |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @param name property 'name' which type is 'phandle' and contains wui info. |
| * @return phandle from 'name' property. |
| */ |
| #define NPCX_DT_PHANDLE_FROM_WUI_NAME(inst, name) \ |
| DT_INST_PHANDLE(inst, name) |
| |
| /** |
| * @brief Construct a npcx_wui structure from 'name' property |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @param name property 'name'which type is 'phandle' and contains wui info. |
| * @return npcx_wui item from 'name' property. |
| */ |
| #define NPCX_DT_WUI_ITEM_BY_NAME(inst, name) \ |
| { \ |
| .table = DT_PROP(DT_PHANDLE(NPCX_DT_PHANDLE_FROM_WUI_NAME(inst, \ |
| name), miwus), index), \ |
| .group = DT_PHA(NPCX_DT_PHANDLE_FROM_WUI_NAME(inst, name), miwus, \ |
| group), \ |
| .bit = DT_PHA(NPCX_DT_PHANDLE_FROM_WUI_NAME(inst, name), miwus, \ |
| bit), \ |
| } |
| |
| /** |
| * @brief Get phandle from 'wui-maps' prop which type is 'phandles' at index 'i' |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @param i index of 'wui-maps' prop which type is 'phandles' |
| * @return phandle from 'wui-maps' prop at index 'i' |
| */ |
| #define NPCX_DT_PHANDLE_FROM_WUI_MAPS(inst, i) \ |
| DT_INST_PHANDLE_BY_IDX(inst, wui_maps, i) |
| |
| /** |
| * @brief Construct a npcx_wui structure from wui-maps property at index 'i' |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @param i index of 'wui-maps' prop which type is 'phandles' |
| * @return npcx_wui item at index 'i' |
| */ |
| #define NPCX_DT_WUI_ITEM_BY_IDX(inst, i) \ |
| { \ |
| .table = DT_PROP(DT_PHANDLE(NPCX_DT_PHANDLE_FROM_WUI_MAPS(inst, i), \ |
| miwus), index), \ |
| .group = DT_PHA(NPCX_DT_PHANDLE_FROM_WUI_MAPS(inst, i), miwus, \ |
| group), \ |
| .bit = DT_PHA(NPCX_DT_PHANDLE_FROM_WUI_MAPS(inst, i), miwus, bit), \ |
| } |
| |
| /** |
| * @brief Length of npcx_wui structures in 'wui-maps' property |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @return length of 'wui-maps' prop which type is 'phandles' |
| */ |
| #define NPCX_DT_WUI_ITEMS_LEN(inst) DT_INST_PROP_LEN(inst, wui_maps) |
| |
| /** |
| * @brief Macro function to construct a list of npcx_wui items by UTIL_LISTIFY |
| * |
| * @param child child index in UTIL_LISTIFY extension. |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @return macro function to construct a npcx_wui structure. |
| */ |
| #define NPCX_DT_WUI_ITEMS_FUNC(child, inst) NPCX_DT_WUI_ITEM_BY_IDX(inst, child) |
| |
| /** |
| * @brief Macro function to construct a list of npcx_wui items by UTIL_LISTIFY |
| * func. |
| * |
| * Example devicetree fragment: |
| * / { |
| * uart1: serial@400c4000 { |
| * uart-rx = <&wui_cr_sin1>; |
| * ... |
| * }; |
| * |
| * gpio0: gpio@40081000 { |
| * wui-maps = <&wui_io00 &wui_io01 &wui_io02 &wui_io03 |
| * &wui_io04 &wui_io05 &wui_io06 &wui_io07>; |
| * ... |
| * }; |
| * }; |
| * |
| * Example usage: |
| * const struct npcx_wui wui_map = NPCX_DT_PHANDLE_FROM_WUI_NAME(inst, uart_rx); |
| * const struct npcx_wui wui_maps[] = NPCX_DT_WUI_ITEMS_LIST(inst); |
| * |
| * @param inst instance number for compatible defined in DT_DRV_COMPAT. |
| * @return an array of npcx_wui items. |
| */ |
| #define NPCX_DT_WUI_ITEMS_LIST(inst) { \ |
| LISTIFY(NPCX_DT_WUI_ITEMS_LEN(inst), \ |
| NPCX_DT_WUI_ITEMS_FUNC, (,), \ |
| inst) \ |
| } |
| |
| /** |
| * @brief Get a node from path '/npcx_miwus_map/map_miwu(0/1/2)_groups' |
| * |
| * @param i index of npcx miwu devices |
| * @return node identifier with that path. |
| */ |
| #define NPCX_DT_NODE_FROM_MIWU_MAP(i) DT_PATH(npcx_miwus_int_map, \ |
| map_miwu##i##_groups) |
| /** |
| * @brief Get the index prop from parent MIWU device node. |
| * |
| * @param child index in UTIL_LISTIFY extension. |
| * @return 'index' prop value of the node which compatible type is |
| * "nuvoton,npcx-miwu". |
| */ |
| #define NPCX_DT_MIWU_IRQ_TABLE_IDX(child) \ |
| DT_PROP(DT_PHANDLE(DT_PARENT(child), parent), index) |
| |
| /** |
| * @brief Macro function for DT_FOREACH_CHILD to generate a IRQ_CONNECT |
| * implementation. |
| * |
| * @param child index in UTIL_LISTIFY extension. |
| * @return implementation to initialize interrupts of MIWU groups and enable |
| * them. |
| */ |
| #define NPCX_DT_MIWU_IRQ_CONNECT_IMPL_CHILD_FUNC(child) \ |
| NPCX_DT_MIWU_IRQ_CONNECT_IMPL_CHILD_FUNC_OBJ(child); |
| |
| #define NPCX_DT_MIWU_IRQ_CONNECT_IMPL_CHILD_FUNC_OBJ(child) \ |
| do { \ |
| IRQ_CONNECT(DT_PROP(child, irq), \ |
| DT_PROP(child, irq_prio), \ |
| NPCX_MIWU_ISR_FUNC(NPCX_DT_MIWU_IRQ_TABLE_IDX(child)), \ |
| DT_PROP(child, group_mask), \ |
| 0); \ |
| irq_enable(DT_PROP(child, irq)); \ |
| } while (0) |
| |
| /** |
| * @brief Get a child node from path '/npcx-espi-vws-map/name'. |
| * |
| * @param name a path which name is /npcx-espi-vws-map/'name'. |
| * @return child node identifier with that path. |
| */ |
| #define NPCX_DT_NODE_FROM_VWTABLE(name) DT_CHILD(DT_PATH(npcx_espi_vws_map), \ |
| name) |
| |
| /** |
| * @brief Get phandle from vw-wui property of child node with that path. |
| * |
| * @param name path which name is /npcx-espi-vws-map/'name'. |
| * @return phandle from "vw-wui" prop of child node with that path. |
| */ |
| #define NPCX_DT_PHANDLE_VW_WUI(name) DT_PHANDLE(NPCX_DT_NODE_FROM_VWTABLE( \ |
| name), vw_wui) |
| |
| /** |
| * @brief Construct a npcx_wui structure from vw-wui property of a child node |
| * with that path. |
| * |
| * @param name a path which name is /npcx-espi-vws-map/'name'. |
| * @return npcx_wui item with that path. |
| */ |
| #define NPCX_DT_VW_WUI_ITEM(name) \ |
| { \ |
| .table = DT_PROP(DT_PHANDLE(NPCX_DT_PHANDLE_VW_WUI(name), miwus), \ |
| index),\ |
| .group = DT_PHA(NPCX_DT_PHANDLE_VW_WUI(name), miwus, group), \ |
| .bit = DT_PHA(NPCX_DT_PHANDLE_VW_WUI(name), miwus, bit), \ |
| } |
| |
| /** |
| * @brief Construct a npcx espi device configuration of vw input signal from |
| * a child node with that path. |
| * |
| * @signal vw input signal name. |
| * @param name a path which name is /npcx-espi-vws-map/'name'. |
| * @return npcx_vw_in_config item with that path. |
| */ |
| #define NPCX_DT_VW_IN_CONF(signal, name) \ |
| { \ |
| .sig = signal, \ |
| .reg_idx = DT_PROP_BY_IDX(NPCX_DT_NODE_FROM_VWTABLE(name), vw_reg, \ |
| 0), \ |
| .bitmask = DT_PROP_BY_IDX(NPCX_DT_NODE_FROM_VWTABLE(name), vw_reg, \ |
| 1), \ |
| .vw_wui = NPCX_DT_VW_WUI_ITEM(name), \ |
| } |
| |
| /** |
| * @brief Construct a npcx espi device configuration of vw output signal from |
| * a child node with that path. |
| * |
| * @signal vw output signal name. |
| * @param name a path which name is /npcx-espi-vws-map/'name'. |
| * @return npcx_vw_in_config item with that path. |
| */ |
| #define NPCX_DT_VW_OUT_CONF(signal, name) \ |
| { \ |
| .sig = signal, \ |
| .reg_idx = DT_PROP_BY_IDX(NPCX_DT_NODE_FROM_VWTABLE(name), vw_reg, \ |
| 0), \ |
| .bitmask = DT_PROP_BY_IDX(NPCX_DT_NODE_FROM_VWTABLE(name), vw_reg, \ |
| 1), \ |
| } |
| |
| /** |
| * @brief Get a node from path '/def_lvol_io_list' which has a property |
| * 'lvol-io-pads' contains low-voltage configurations and need to set |
| * by default. |
| * |
| * @return node identifier with that path. |
| */ |
| #define NPCX_DT_NODE_DEF_LVOL_LIST DT_PATH(def_lvol_io_list) |
| |
| /** |
| * @brief Length of npcx_lvol structures in 'lvol-io-pads' property |
| * |
| * @return length of 'lvol-io-pads' prop which type is 'phandles' |
| */ |
| #define NPCX_DT_LVOL_ITEMS_LEN DT_PROP_LEN(NPCX_DT_NODE_DEF_LVOL_LIST, \ |
| lvol_io_pads) |
| |
| /** |
| * @brief Get phandle from 'lvol-io-pads' prop which type is 'phandles' at index |
| * 'i' |
| * |
| * @param i index of 'lvol-io-pads' prop which type is 'phandles' |
| * @return phandle from 'lvol-io-pads' prop at index 'i' |
| */ |
| #define NPCX_DT_PHANDLE_FROM_LVOL_IO_PADS(i) \ |
| DT_PHANDLE_BY_IDX(NPCX_DT_NODE_DEF_LVOL_LIST, lvol_io_pads, i) |
| |
| /** |
| * @brief Construct a npcx_lvol structure from 'lvol-io-pads' property at index |
| * 'i'. |
| * |
| * @param i index of 'lvol-io-pads' prop which type is 'phandles' |
| * @return npcx_lvol item from 'lvol-io-pads' property at index 'i' |
| */ |
| #define NPCX_DT_LVOL_ITEMS_BY_IDX(i, _) \ |
| { \ |
| .io_port = DT_PHA(NPCX_DT_PHANDLE_FROM_LVOL_IO_PADS(i), \ |
| lvols, io_port), \ |
| .io_bit = DT_PHA(NPCX_DT_PHANDLE_FROM_LVOL_IO_PADS(i), \ |
| lvols, io_bit), \ |
| .ctrl = DT_PHA(NPCX_DT_PHANDLE_FROM_LVOL_IO_PADS(i), \ |
| lvols, ctrl), \ |
| .bit = DT_PHA(NPCX_DT_PHANDLE_FROM_LVOL_IO_PADS(i), \ |
| lvols, bit), \ |
| } |
| |
| /** |
| * @brief Macro function to construct a list of npcx_lvol items by UTIL_LISTIFY |
| * func. |
| * |
| * Example devicetree fragment: |
| * / { |
| * def_lvol_io_list { |
| * compatible = "nuvoton,npcx-lvolctrl-def"; |
| * lvol-io-pads = <&lvol_io90 // I2C1_SCL0 1.8V support |
| * &lvol_io87>; // I2C1_SDA0 1,8V support |
| * }; |
| * }; |
| * |
| * Example usage: |
| * static const struct npcx_lvol def_lvols[] = NPCX_DT_IO_LVOL_ITEMS_DEF_LIST; |
| * |
| * @return an array of npcx_lvol items which configure low-voltage support |
| */ |
| #define NPCX_DT_IO_LVOL_ITEMS_DEF_LIST { \ |
| LISTIFY(NPCX_DT_LVOL_ITEMS_LEN, \ |
| NPCX_DT_LVOL_ITEMS_BY_IDX, (,), _) \ |
| } |
| |
| /** |
| * @brief Get a node from path '/vsby-psl-in-list' which has a property |
| * 'psl-in-pads' contains Power Switch Logic (PSL) input pads which are |
| * in charge of detecting wake-up events on VSBY power domain. |
| * |
| * @return node identifier with that path. |
| */ |
| #define NPCX_DT_NODE_PSL_IN_LIST DT_PATH(vsby_psl_in_list) |
| |
| /** |
| * @brief Length of npcx_psl_in structures in 'psl-in-pads' property |
| * |
| * @return length of 'psl-in-pads' prop which type is 'phandles' |
| */ |
| #define NPCX_DT_PSL_IN_ITEMS_LEN DT_PROP_LEN(NPCX_DT_NODE_PSL_IN_LIST, \ |
| psl_in_pads) |
| |
| /** |
| * @brief Get phandle from 'psl-in-pads' prop which type is 'phandles' at index |
| * 'i' |
| * |
| * @param i index of 'psl-in-pads' prop which type is 'phandles' |
| * @return phandle from 'psl-in-pads' prop at index 'i' |
| */ |
| #define NPCX_DT_PHANDLE_FROM_PSL_IN_NODE(i) \ |
| DT_PHANDLE_BY_IDX(NPCX_DT_NODE_PSL_IN_LIST, psl_in_pads, i) |
| |
| /** |
| * @brief Get phandle from 'pinctrl-0' prop which type is 'phandles' at index |
| * 'i' |
| * |
| * @param i index of 'psl-in-pads' prop which type is 'phandles' |
| * @return phandle from 'pinctrl-0' prop at index 'i' |
| */ |
| #define NPCX_DT_PHANDLE_FROM_PSL_PINMUX_NODE(i) \ |
| DT_PINCTRL_0(NPCX_DT_PHANDLE_FROM_PSL_IN_NODE(i), 0) |
| |
| /** |
| * @brief Get phandle from 'polarity-0' prop which type is 'phandles' at index |
| * 'i' |
| * |
| * @param i index of 'psl-in-pads' prop which type is 'phandles' |
| * @return phandle from 'polarity-0' prop at index 'i' |
| */ |
| #define NPCX_DT_PHANDLE_FROM_PSL_POLARITY_NODE(i) \ |
| DT_PHANDLE(NPCX_DT_PHANDLE_FROM_PSL_IN_NODE(i), polarity_0) |
| |
| /** |
| * @brief Construct a npcx_alt structure from 'pinctrl-0' property at index 'i' |
| * of 'psl-in-pads' prop. |
| * |
| * @param i index of 'psl-in-pads' prop which type is 'phandles' |
| * @return npcx_alt item from 'pinctrl-0' property at index 'i' |
| */ |
| #define NPCX_DT_PSL_IN_ALT_CONF_BY_IDX(i) \ |
| { \ |
| .group = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_PINMUX_NODE(i), alts, group), \ |
| .bit = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_PINMUX_NODE(i), alts, bit), \ |
| .inverted = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_PINMUX_NODE(i), alts, inv), \ |
| }, |
| |
| /** |
| * @brief Construct a npcx_alt structure from 'polarity-0' property at index 'i' |
| * of 'psl-in-pads' prop. |
| * |
| * @param i index of 'psl-in-pads' prop which type is 'phandles' |
| * @return npcx_alt item from 'pinctrl-0' property at index 'i' |
| */ |
| #define NPCX_DT_PSL_IN_POL_CONF_BY_IDX(i) \ |
| { \ |
| .group = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_POLARITY_NODE(i), alts, group), \ |
| .bit = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_POLARITY_NODE(i), alts, bit), \ |
| .inverted = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_POLARITY_NODE(i), alts, inv), \ |
| }, |
| |
| /** |
| * @brief Construct a npcx_psl_in structure from 'psl-in-pads' property at index |
| * 'i' |
| * |
| * @param i index of 'psl-in-pads' prop which type is 'phandles' |
| * @return npcx_psl_in item from 'psl-in-pads' property at index 'i' |
| */ |
| #define NPCX_DT_PSL_IN_ITEMS_BY_IDX(i, _) \ |
| { \ |
| .flag = DT_PROP(NPCX_DT_PHANDLE_FROM_PSL_IN_NODE(i), flag), \ |
| .offset = DT_PROP(NPCX_DT_PHANDLE_FROM_PSL_IN_NODE(i), offset),\ |
| .pinctrl = NPCX_DT_PSL_IN_ALT_CONF_BY_IDX(i) \ |
| .polarity = NPCX_DT_PSL_IN_POL_CONF_BY_IDX(i) \ |
| } |
| |
| /** |
| * @brief Macro function to construct a list of npcx_psl_in items by |
| * UTIL_LISTIFY func. |
| * |
| * Example devicetree fragment: |
| * / { |
| * vsby-psl-in-list { |
| * psl-in-pads = <&psl_in1>; |
| * }; |
| * }; |
| * &psl_in1 { |
| * flag = <NPCX_PSL_FALLING_EDGE>; |
| * }; |
| * |
| * Example usage: |
| * static const struct npcx_psl_in psl_in_confs[] = NPCX_DT_PSL_IN_ITEMS_LIST; |
| * |
| * @return an array of npcx_psl_in items which configures PSL input pads |
| */ |
| #define NPCX_DT_PSL_IN_ITEMS_LIST { \ |
| LISTIFY(NPCX_DT_PSL_IN_ITEMS_LEN, \ |
| NPCX_DT_PSL_IN_ITEMS_BY_IDX, (,), _) \ |
| } |
| |
| /** |
| * @brief Get base address of corresponding GPIO controller for enabling PSL |
| * output. |
| * |
| * @param @param inst number for devices with compatible 'nuvoton_npcx_psl_out'. |
| * @return base address of corresponding GPIO controller |
| */ |
| #define NPCX_DT_PSL_OUT_CONTROLLER(inst) DT_REG_ADDR_BY_IDX(DT_PHANDLE_BY_IDX( \ |
| DT_INST(inst, nuvoton_npcx_psl_out), controller, 0), 0) |
| |
| /** |
| * @brief Get pin of corresponding GPIO controller for enabling PSL output. |
| * |
| * @param @param inst number for devices with compatible 'nuvoton_npcx_psl_out'. |
| * @return pin of corresponding GPIO controller. |
| */ |
| #define NPCX_DT_PSL_OUT_PIN(inst) DT_PROP(DT_INST(inst, nuvoton_npcx_psl_out), \ |
| pin) |
| |
| /** |
| * @brief Check if the host interface type is automatically configured by |
| * booter. |
| * |
| * @return TRUE - if the host interface is configured by booter, |
| * FALSE - otherwise. |
| */ |
| #define NPCX_BOOTER_IS_HIF_TYPE_SET() \ |
| DT_PROP(DT_PATH(booter_variant), hif_type_auto) |
| |
| #endif /* _NUVOTON_NPCX_SOC_DT_H_ */ |
