soc/ambiq/apollo4x/pinctrl_soc.h

/*
 * Copyright (c) 2023 Antmicro <www.antmicro.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#ifndef ZEPHYR_SOC_ARM_AMBIQ_APOLLO4_PINCTRL_SOC_H_
#define ZEPHYR_SOC_ARM_AMBIQ_APOLLO4_PINCTRL_SOC_H_

#include <zephyr/dt-bindings/pinctrl/ambiq-apollo4-pinctrl.h>

/**
 * @brief Type to hold a pin's pinctrl configuration.
 */
struct apollo4_pinctrl_soc_pin {
	/** Pin number 0..128 */
	uint32_t pin_num : 7;
	/** Alternative function (UART, SPI, etc.) */
	uint32_t alt_func : 4;
	/** Enable the pin as an input */
	uint32_t input_enable : 1;
	/** Drive strength, relative to full-driver strength */
	uint32_t drive_strength : 2;
	/** Slew rate, may be either false (slow) or true (fast) */
	uint32_t slew_rate : 1;
	/** Drive actively high or low */
	uint32_t push_pull : 1;
	/** Drive with open drain */
	uint32_t open_drain : 1;
	/** High impedance mode */
	uint32_t tristate : 1;
	/** Enable the internal pull up resistor */
	uint32_t bias_pull_up : 1;
	/** Enable the internal pull down resistor */
	uint32_t bias_pull_down : 1;
	/** pullup resistor value */
	uint32_t ambiq_pull_up_ohms : 3;
	/** IOM nCE module select */
	uint32_t iom_nce : 6;
};

typedef struct apollo4_pinctrl_soc_pin pinctrl_soc_pin_t;

/**
 * @brief Utility macro to initialize each pin.
 *
 * @param node_id Node identifier.
 * @param prop Property name.
 * @param idx Property entry index.
 */
#define Z_PINCTRL_STATE_PIN_INIT(node_id, prop, idx)				\
	{									\
		APOLLO4_GET_PIN_NUM(DT_PROP_BY_IDX(node_id, prop, idx)),	\
		APOLLO4_GET_PIN_ALT_FUNC(DT_PROP_BY_IDX(node_id, prop, idx)),	\
		DT_PROP(node_id, input_enable),					\
		DT_ENUM_IDX(node_id, drive_strength),				\
		DT_ENUM_IDX(node_id, slew_rate),				\
		DT_PROP(node_id, drive_push_pull),				\
		DT_PROP(node_id, drive_open_drain),				\
		DT_PROP(node_id, bias_high_impedance),				\
		DT_PROP(node_id, bias_pull_up),					\
		DT_PROP(node_id, bias_pull_down),				\
		DT_ENUM_IDX(node_id, ambiq_pull_up_ohms),			\
		DT_PROP(node_id, ambiq_iom_nce_module),				\
	},

/**
 * @brief Utility macro to initialize state pins contained in a given property.
 *
 * @param node_id Node identifier.
 * @param prop Property name describing state pins.
 */
#define Z_PINCTRL_STATE_PINS_INIT(node_id, prop)				\
	{DT_FOREACH_CHILD_VARGS(DT_PHANDLE(node_id, prop),			\
				DT_FOREACH_PROP_ELEM, pinmux,			\
				Z_PINCTRL_STATE_PIN_INIT)}

#define APOLLO4_GET_PIN_NUM(pinctrl) \
	(((pinctrl) >> APOLLO4_PIN_NUM_POS) & APOLLO4_PIN_NUM_MASK)
#define APOLLO4_GET_PIN_ALT_FUNC(pinctrl) \
	(((pinctrl) >> APOLLO4_ALT_FUNC_POS) & APOLLO4_ALT_FUNC_MASK)

#endif /* ZEPHYR_SOC_ARM_AMBIQ_APOLLO4_PINCTRL_SOC_H_ */