14f5f5887SNishad Kamdar /* SPDX-License-Identifier: GPL-2.0+ */
284130aacSRichard Genoud /*
384130aacSRichard Genoud * Helpers for controlling modem lines via GPIO
484130aacSRichard Genoud *
584130aacSRichard Genoud * Copyright (C) 2014 Paratronic S.A.
684130aacSRichard Genoud */
784130aacSRichard Genoud
884130aacSRichard Genoud #ifndef __SERIAL_MCTRL_GPIO__
984130aacSRichard Genoud #define __SERIAL_MCTRL_GPIO__
1084130aacSRichard Genoud
1184130aacSRichard Genoud #include <linux/err.h>
1284130aacSRichard Genoud #include <linux/device.h>
1384130aacSRichard Genoud #include <linux/gpio/consumer.h>
1484130aacSRichard Genoud
15ce59e48fSUwe Kleine-König struct uart_port;
16ce59e48fSUwe Kleine-König
1784130aacSRichard Genoud enum mctrl_gpio_idx {
1884130aacSRichard Genoud UART_GPIO_CTS,
1984130aacSRichard Genoud UART_GPIO_DSR,
2084130aacSRichard Genoud UART_GPIO_DCD,
2184130aacSRichard Genoud UART_GPIO_RNG,
2284130aacSRichard Genoud UART_GPIO_RI = UART_GPIO_RNG,
2384130aacSRichard Genoud UART_GPIO_RTS,
2484130aacSRichard Genoud UART_GPIO_DTR,
2584130aacSRichard Genoud UART_GPIO_MAX,
2684130aacSRichard Genoud };
2784130aacSRichard Genoud
2884130aacSRichard Genoud /*
2984130aacSRichard Genoud * Opaque descriptor for modem lines controlled by GPIOs
3084130aacSRichard Genoud */
3184130aacSRichard Genoud struct mctrl_gpios;
3284130aacSRichard Genoud
3384130aacSRichard Genoud #ifdef CONFIG_GPIOLIB
3484130aacSRichard Genoud
3584130aacSRichard Genoud /*
3684130aacSRichard Genoud * Set state of the modem control output lines via GPIOs.
3784130aacSRichard Genoud */
3884130aacSRichard Genoud void mctrl_gpio_set(struct mctrl_gpios *gpios, unsigned int mctrl);
3984130aacSRichard Genoud
4084130aacSRichard Genoud /*
41bf5cee68SYegor Yefremov * Get state of the modem control input lines from GPIOs.
4284130aacSRichard Genoud * The mctrl flags are updated and returned.
4384130aacSRichard Genoud */
4484130aacSRichard Genoud unsigned int mctrl_gpio_get(struct mctrl_gpios *gpios, unsigned int *mctrl);
4584130aacSRichard Genoud
4684130aacSRichard Genoud /*
47bf5cee68SYegor Yefremov * Get state of the modem control output lines from GPIOs.
48bf5cee68SYegor Yefremov * The mctrl flags are updated and returned.
49bf5cee68SYegor Yefremov */
50bf5cee68SYegor Yefremov unsigned int
51bf5cee68SYegor Yefremov mctrl_gpio_get_outputs(struct mctrl_gpios *gpios, unsigned int *mctrl);
52bf5cee68SYegor Yefremov
53bf5cee68SYegor Yefremov /*
5484130aacSRichard Genoud * Returns the associated struct gpio_desc to the modem line gidx
5584130aacSRichard Genoud */
5684130aacSRichard Genoud struct gpio_desc *mctrl_gpio_to_gpiod(struct mctrl_gpios *gpios,
5784130aacSRichard Genoud enum mctrl_gpio_idx gidx);
5884130aacSRichard Genoud
5984130aacSRichard Genoud /*
6003e970bbSGeert Uytterhoeven * Request and set direction of modem control line GPIOs and set up irq
61ce59e48fSUwe Kleine-König * handling.
62ce59e48fSUwe Kleine-König * devm_* functions are used, so there's no need to call mctrl_gpio_free().
63ce59e48fSUwe Kleine-König * Returns a pointer to the allocated mctrl structure if ok, -ENOMEM on
64ce59e48fSUwe Kleine-König * allocation error.
65ce59e48fSUwe Kleine-König */
66ce59e48fSUwe Kleine-König struct mctrl_gpios *mctrl_gpio_init(struct uart_port *port, unsigned int idx);
67ce59e48fSUwe Kleine-König
68ce59e48fSUwe Kleine-König /*
6903e970bbSGeert Uytterhoeven * Request and set direction of modem control line GPIOs.
7084130aacSRichard Genoud * devm_* functions are used, so there's no need to call mctrl_gpio_free().
7184130aacSRichard Genoud * Returns a pointer to the allocated mctrl structure if ok, -ENOMEM on
7284130aacSRichard Genoud * allocation error.
7384130aacSRichard Genoud */
747d8c70d8SUwe Kleine-König struct mctrl_gpios *mctrl_gpio_init_noauto(struct device *dev,
757d8c70d8SUwe Kleine-König unsigned int idx);
7684130aacSRichard Genoud
7784130aacSRichard Genoud /*
7884130aacSRichard Genoud * Free the mctrl_gpios structure.
7984130aacSRichard Genoud * Normally, this function will not be called, as the GPIOs will
8084130aacSRichard Genoud * be disposed of by the resource management code.
8184130aacSRichard Genoud */
8284130aacSRichard Genoud void mctrl_gpio_free(struct device *dev, struct mctrl_gpios *gpios);
8384130aacSRichard Genoud
84ce59e48fSUwe Kleine-König /*
85ce59e48fSUwe Kleine-König * Enable gpio interrupts to report status line changes.
86ce59e48fSUwe Kleine-König */
87ce59e48fSUwe Kleine-König void mctrl_gpio_enable_ms(struct mctrl_gpios *gpios);
88ce59e48fSUwe Kleine-König
89ce59e48fSUwe Kleine-König /*
90ce59e48fSUwe Kleine-König * Disable gpio interrupts to report status line changes.
91ce59e48fSUwe Kleine-König */
92ce59e48fSUwe Kleine-König void mctrl_gpio_disable_ms(struct mctrl_gpios *gpios);
93ce59e48fSUwe Kleine-König
94*9978c2f1SErwan Le Ray /*
95*9978c2f1SErwan Le Ray * Enable gpio wakeup interrupts to enable wake up source.
96*9978c2f1SErwan Le Ray */
97*9978c2f1SErwan Le Ray void mctrl_gpio_enable_irq_wake(struct mctrl_gpios *gpios);
98*9978c2f1SErwan Le Ray
99*9978c2f1SErwan Le Ray /*
100*9978c2f1SErwan Le Ray * Disable gpio wakeup interrupts to enable wake up source.
101*9978c2f1SErwan Le Ray */
102*9978c2f1SErwan Le Ray void mctrl_gpio_disable_irq_wake(struct mctrl_gpios *gpios);
103*9978c2f1SErwan Le Ray
10484130aacSRichard Genoud #else /* GPIOLIB */
10584130aacSRichard Genoud
10684130aacSRichard Genoud static inline
mctrl_gpio_set(struct mctrl_gpios * gpios,unsigned int mctrl)10784130aacSRichard Genoud void mctrl_gpio_set(struct mctrl_gpios *gpios, unsigned int mctrl)
10884130aacSRichard Genoud {
10984130aacSRichard Genoud }
11084130aacSRichard Genoud
11184130aacSRichard Genoud static inline
mctrl_gpio_get(struct mctrl_gpios * gpios,unsigned int * mctrl)11284130aacSRichard Genoud unsigned int mctrl_gpio_get(struct mctrl_gpios *gpios, unsigned int *mctrl)
11384130aacSRichard Genoud {
11484130aacSRichard Genoud return *mctrl;
11584130aacSRichard Genoud }
11684130aacSRichard Genoud
117bf5cee68SYegor Yefremov static inline unsigned int
mctrl_gpio_get_outputs(struct mctrl_gpios * gpios,unsigned int * mctrl)118bf5cee68SYegor Yefremov mctrl_gpio_get_outputs(struct mctrl_gpios *gpios, unsigned int *mctrl)
119bf5cee68SYegor Yefremov {
120bf5cee68SYegor Yefremov return *mctrl;
121bf5cee68SYegor Yefremov }
122bf5cee68SYegor Yefremov
12384130aacSRichard Genoud static inline
mctrl_gpio_to_gpiod(struct mctrl_gpios * gpios,enum mctrl_gpio_idx gidx)12484130aacSRichard Genoud struct gpio_desc *mctrl_gpio_to_gpiod(struct mctrl_gpios *gpios,
12584130aacSRichard Genoud enum mctrl_gpio_idx gidx)
12684130aacSRichard Genoud {
127e8b2a618SFrieder Schrempf return NULL;
12884130aacSRichard Genoud }
12984130aacSRichard Genoud
13084130aacSRichard Genoud static inline
mctrl_gpio_init(struct uart_port * port,unsigned int idx)131ce59e48fSUwe Kleine-König struct mctrl_gpios *mctrl_gpio_init(struct uart_port *port, unsigned int idx)
132ce59e48fSUwe Kleine-König {
133e8b2a618SFrieder Schrempf return NULL;
134ce59e48fSUwe Kleine-König }
135ce59e48fSUwe Kleine-König
136ce59e48fSUwe Kleine-König static inline
mctrl_gpio_init_noauto(struct device * dev,unsigned int idx)1377d8c70d8SUwe Kleine-König struct mctrl_gpios *mctrl_gpio_init_noauto(struct device *dev, unsigned int idx)
13884130aacSRichard Genoud {
139e8b2a618SFrieder Schrempf return NULL;
14084130aacSRichard Genoud }
14184130aacSRichard Genoud
14284130aacSRichard Genoud static inline
mctrl_gpio_free(struct device * dev,struct mctrl_gpios * gpios)14384130aacSRichard Genoud void mctrl_gpio_free(struct device *dev, struct mctrl_gpios *gpios)
14484130aacSRichard Genoud {
14584130aacSRichard Genoud }
14684130aacSRichard Genoud
mctrl_gpio_enable_ms(struct mctrl_gpios * gpios)1471b306f99SArnd Bergmann static inline void mctrl_gpio_enable_ms(struct mctrl_gpios *gpios)
148ce59e48fSUwe Kleine-König {
149ce59e48fSUwe Kleine-König }
150ce59e48fSUwe Kleine-König
mctrl_gpio_disable_ms(struct mctrl_gpios * gpios)1511b306f99SArnd Bergmann static inline void mctrl_gpio_disable_ms(struct mctrl_gpios *gpios)
152ce59e48fSUwe Kleine-König {
153ce59e48fSUwe Kleine-König }
154ce59e48fSUwe Kleine-König
mctrl_gpio_enable_irq_wake(struct mctrl_gpios * gpios)155*9978c2f1SErwan Le Ray static inline void mctrl_gpio_enable_irq_wake(struct mctrl_gpios *gpios)
156*9978c2f1SErwan Le Ray {
157*9978c2f1SErwan Le Ray }
158*9978c2f1SErwan Le Ray
mctrl_gpio_disable_irq_wake(struct mctrl_gpios * gpios)159*9978c2f1SErwan Le Ray static inline void mctrl_gpio_disable_irq_wake(struct mctrl_gpios *gpios)
160*9978c2f1SErwan Le Ray {
161*9978c2f1SErwan Le Ray }
162*9978c2f1SErwan Le Ray
16384130aacSRichard Genoud #endif /* GPIOLIB */
16484130aacSRichard Genoud
16584130aacSRichard Genoud #endif
166