xref: /freebsd/sys/contrib/device-tree/Bindings/pinctrl/qcom,sdm660-pinctrl.txt (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)

Qualcomm Technologies, Inc. SDM660 TLMM block

This binding describes the Top Level Mode Multiplexer block found in the
SDM660 platform.

- compatible:
	Usage: required
	Value type: <string>
	Definition: must be "qcom,sdm660-pinctrl" or
		    "qcom,sdm630-pinctrl".

- reg:
	Usage: required
	Value type: <prop-encoded-array>
	Definition: the base address and size of the north, center and south
		    TLMM tiles.

- reg-names:
       Usage: required
       Value type: <stringlist>
       Definition: names for the cells of reg, must contain "north", "center"
                   and "south".

- interrupts:
	Usage: required
	Value type: <prop-encoded-array>
	Definition: should specify the TLMM summary IRQ.

- interrupt-controller:
	Usage: required
	Value type: <none>
	Definition: identifies this node as an interrupt controller

- #interrupt-cells:
	Usage: required
	Value type: <u32>
	Definition: must be 2. Specifying the pin number and flags, as defined
		    in <dt-bindings/interrupt-controller/irq.h>

- gpio-controller:
	Usage: required
	Value type: <none>
	Definition: identifies this node as a gpio controller

- gpio-ranges:
	Usage: required
	Value type: <prop-encoded-array>
	Definition: Specifies the mapping between gpio controller and
		    pin-controller pins.

- #gpio-cells:
	Usage: required
	Value type: <u32>
	Definition: must be 2. Specifying the pin number and flags, as defined
		    in <dt-bindings/gpio/gpio.h>

Please refer to ../gpio/gpio.txt and ../interrupt-controller/interrupts.txt for
a general description of GPIO and interrupt bindings.

Please refer to pinctrl-bindings.txt in this directory for details of the
common pinctrl bindings used by client devices, including the meaning of the
phrase "pin configuration node".

The pin configuration nodes act as a container for an arbitrary number of
subnodes. Each of these subnodes represents some desired configuration for a
pin, a group, or a list of pins or groups. This configuration can include the
mux function to select on those pin(s)/group(s), and various pin configuration
parameters, such as pull-up, drive strength, etc.


PIN CONFIGURATION NODES:

The name of each subnode is not important; all subnodes should be enumerated
and processed purely based on their content.

Each subnode only affects those parameters that are explicitly listed. In
other words, a subnode that lists a mux function but no pin configuration
parameters implies no information about any pin configuration parameters.
Similarly, a pin subnode that describes a pullup parameter implies no
information about e.g. the mux function.


The following generic properties as defined in pinctrl-bindings.txt are valid
to specify in a pin configuration subnode:

- pins:
	Usage: required
	Value type: <string-array>
	Definition: List of gpio pins affected by the properties specified in
		    this subnode.  Valid pins are:
		    gpio0-gpio113,
		        Supports mux, bias and drive-strength
		    sdc1_clk, sdc1_cmd, sdc1_data sdc2_clk, sdc2_cmd, sdc2_data sdc1_rclk,
		        Supports bias and drive-strength

- function:
	Usage: required
	Value type: <string>
	Definition: Specify the alternative function to be configured for the
		    specified pins. Functions are only valid for gpio pins.
		    Valid values are:
		    adsp_ext, agera_pll, atest_char, atest_char0, atest_char1,
		    atest_char2, atest_char3, atest_gpsadc0, atest_gpsadc1,
		    atest_tsens, atest_tsens2, atest_usb1, atest_usb10,
		    atest_usb11, atest_usb12, atest_usb13, atest_usb2,
		    atest_usb20, atest_usb21, atest_usb22, atest_usb23,
		    audio_ref, bimc_dte0, bimc_dte1, blsp_i2c1, blsp_i2c2,
		    blsp_i2c3, blsp_i2c4, blsp_i2c5, blsp_i2c6, blsp_i2c7,
		    blsp_i2c8_a, blsp_i2c8_b, blsp_spi1, blsp_spi2, blsp_spi3,
		    blsp_spi3_cs1, blsp_spi3_cs2, blsp_spi4, blsp_spi5,
		    blsp_spi6, blsp_spi7, blsp_spi8_a, blsp_spi8_b,
		    blsp_spi8_cs1, blsp_spi8_cs2, blsp_uart1, blsp_uart2,
		    blsp_uart5, blsp_uart6_a, blsp_uart6_b, blsp_uim1,
		    blsp_uim2, blsp_uim5, blsp_uim6, cam_mclk, cci_async,
		    cci_i2c, cri_trng, cri_trng0, cri_trng1, dbg_out, ddr_bist,
		    gcc_gp1, gcc_gp2, gcc_gp3, gpio, gps_tx_a, gps_tx_b, gps_tx_c,
		    isense_dbg, jitter_bist, ldo_en, ldo_update, m_voc, mdp_vsync,
		    mdss_vsync0, mdss_vsync1, mdss_vsync2, mdss_vsync3, mss_lte,
		    nav_pps_a, nav_pps_b, nav_pps_c, pa_indicator, phase_flag0,
		    phase_flag1, phase_flag10, phase_flag11, phase_flag12,
		    phase_flag13, phase_flag14, phase_flag15, phase_flag16,
		    phase_flag17, phase_flag18, phase_flag19, phase_flag2,
		    phase_flag20, phase_flag21, phase_flag22, phase_flag23,
		    phase_flag24, phase_flag25, phase_flag26, phase_flag27,
		    phase_flag28, phase_flag29, phase_flag3, phase_flag30,
		    phase_flag31, phase_flag4, phase_flag5, phase_flag6,
		    phase_flag7, phase_flag8, phase_flag9, pll_bypassnl,
		    pll_reset, pri_mi2s, pri_mi2s_ws, prng_rosc, pwr_crypto,
		    pwr_modem, pwr_nav, qdss_cti0_a, qdss_cti0_b, qdss_cti1_a,
		    qdss_cti1_b, qdss_gpio, qdss_gpio0, qdss_gpio1, qdss_gpio10,
		    qdss_gpio11, qdss_gpio12, qdss_gpio13, qdss_gpio14, qdss_gpio15,
		    qdss_gpio2, qdss_gpio3, qdss_gpio4, qdss_gpio5, qdss_gpio6,
		    qdss_gpio7, qdss_gpio8, qdss_gpio9, qlink_enable, qlink_request,
		    qspi_clk, qspi_cs, qspi_data0, qspi_data1, qspi_data2,
		    qspi_data3, qspi_resetn, sec_mi2s, sndwire_clk, sndwire_data,
		    sp_cmu, ssc_irq, tgu_ch0, tgu_ch1, tsense_pwm1, tsense_pwm2,
		    uim1_clk, uim1_data, uim1_present, uim1_reset, uim2_clk,
		    uim2_data, uim2_present, uim2_reset, uim_batt, vfr_1,
		    vsense_clkout, vsense_data0, vsense_data1, vsense_mode,
		    wlan1_adc0, wlan1_adc1, wlan2_adc0, wlan2_adc1

- bias-disable:
	Usage: optional
	Value type: <none>
	Definition: The specified pins should be configured as no pull.

- bias-pull-down:
	Usage: optional
	Value type: <none>
	Definition: The specified pins should be configured as pull down.

- bias-pull-up:
	Usage: optional
	Value type: <none>
	Definition: The specified pins should be configured as pull up.

- output-high:
	Usage: optional
	Value type: <none>
	Definition: The specified pins are configured in output mode, driven
		    high.
		    Not valid for sdc pins.

- output-low:
	Usage: optional
	Value type: <none>
	Definition: The specified pins are configured in output mode, driven
		    low.
		    Not valid for sdc pins.

- drive-strength:
	Usage: optional
	Value type: <u32>
	Definition: Selects the drive strength for the specified pins, in mA.
		    Valid values are: 2, 4, 6, 8, 10, 12, 14 and 16

Example:

	tlmm: pinctrl@3100000 {
		compatible = "qcom,sdm660-pinctrl";
		reg = <0x3100000 0x200000>,
		      <0x3500000 0x200000>,
		      <0x3900000 0x200000>;
		reg-names = "south", "center", "north";
		interrupts = <GIC_SPI 208 IRQ_TYPE_LEVEL_HIGH>;
		gpio-controller;
		gpio-ranges = <&tlmm 0 0 114>;
		#gpio-cells = <2>;
		interrupt-controller;
		#interrupt-cells = <2>;
	};