GNU Linux-libre 4.9.309-gnu1
[releases.git] / drivers / tty / serial / pic32_uart.h
1 /*
2  * PIC32 Integrated Serial Driver.
3  *
4  * Copyright (C) 2015 Microchip Technology, Inc.
5  *
6  * Authors:
7  *   Sorin-Andrei Pistirica <andrei.pistirica@microchip.com>
8  *
9  * Licensed under GPLv2 or later.
10  */
11 #ifndef __DT_PIC32_UART_H__
12 #define __DT_PIC32_UART_H__
13
14 #define PIC32_UART_DFLT_BRATE           (9600)
15 #define PIC32_UART_TX_FIFO_DEPTH        (8)
16 #define PIC32_UART_RX_FIFO_DEPTH        (8)
17
18 #define PIC32_UART_MODE         0x00
19 #define PIC32_UART_STA          0x10
20 #define PIC32_UART_TX           0x20
21 #define PIC32_UART_RX           0x30
22 #define PIC32_UART_BRG          0x40
23
24 struct pic32_console_opt {
25         int baud;
26         int parity;
27         int bits;
28         int flow;
29 };
30
31 /* struct pic32_sport - pic32 serial port descriptor
32  * @port: uart port descriptor
33  * @idx: port index
34  * @irq_fault: virtual fault interrupt number
35  * @irqflags_fault: flags related to fault irq
36  * @irq_fault_name: irq fault name
37  * @irq_rx: virtual rx interrupt number
38  * @irqflags_rx: flags related to rx irq
39  * @irq_rx_name: irq rx name
40  * @irq_tx: virtual tx interrupt number
41  * @irqflags_tx: : flags related to tx irq
42  * @irq_tx_name: irq tx name
43  * @cts_gpio: clear to send gpio
44  * @dev: device descriptor
45  **/
46 struct pic32_sport {
47         struct uart_port port;
48         struct pic32_console_opt opt;
49         int idx;
50
51         int irq_fault;
52         int irqflags_fault;
53         const char *irq_fault_name;
54         int irq_rx;
55         int irqflags_rx;
56         const char *irq_rx_name;
57         int irq_tx;
58         int irqflags_tx;
59         const char *irq_tx_name;
60         u8 enable_tx_irq;
61
62         bool hw_flow_ctrl;
63         int cts_gpio;
64
65         int ref_clk;
66         struct clk *clk;
67
68         struct device *dev;
69 };
70 #define to_pic32_sport(c) container_of(c, struct pic32_sport, port)
71 #define pic32_get_port(sport) (&sport->port)
72 #define pic32_get_opt(sport) (&sport->opt)
73 #define tx_irq_enabled(sport) (sport->enable_tx_irq)
74
75 static inline void pic32_uart_writel(struct pic32_sport *sport,
76                                         u32 reg, u32 val)
77 {
78         struct uart_port *port = pic32_get_port(sport);
79
80         __raw_writel(val, port->membase + reg);
81 }
82
83 static inline u32 pic32_uart_readl(struct pic32_sport *sport, u32 reg)
84 {
85         struct uart_port *port = pic32_get_port(sport);
86
87         return  __raw_readl(port->membase + reg);
88 }
89
90 /* pic32 uart mode register bits */
91 #define PIC32_UART_MODE_ON        BIT(15)
92 #define PIC32_UART_MODE_FRZ       BIT(14)
93 #define PIC32_UART_MODE_SIDL      BIT(13)
94 #define PIC32_UART_MODE_IREN      BIT(12)
95 #define PIC32_UART_MODE_RTSMD     BIT(11)
96 #define PIC32_UART_MODE_RESV1     BIT(10)
97 #define PIC32_UART_MODE_UEN1      BIT(9)
98 #define PIC32_UART_MODE_UEN0      BIT(8)
99 #define PIC32_UART_MODE_WAKE      BIT(7)
100 #define PIC32_UART_MODE_LPBK      BIT(6)
101 #define PIC32_UART_MODE_ABAUD     BIT(5)
102 #define PIC32_UART_MODE_RXINV     BIT(4)
103 #define PIC32_UART_MODE_BRGH      BIT(3)
104 #define PIC32_UART_MODE_PDSEL1    BIT(2)
105 #define PIC32_UART_MODE_PDSEL0    BIT(1)
106 #define PIC32_UART_MODE_STSEL     BIT(0)
107
108 /* pic32 uart status register bits */
109 #define PIC32_UART_STA_UTXISEL1   BIT(15)
110 #define PIC32_UART_STA_UTXISEL0   BIT(14)
111 #define PIC32_UART_STA_UTXINV     BIT(13)
112 #define PIC32_UART_STA_URXEN      BIT(12)
113 #define PIC32_UART_STA_UTXBRK     BIT(11)
114 #define PIC32_UART_STA_UTXEN      BIT(10)
115 #define PIC32_UART_STA_UTXBF      BIT(9)
116 #define PIC32_UART_STA_TRMT       BIT(8)
117 #define PIC32_UART_STA_URXISEL1   BIT(7)
118 #define PIC32_UART_STA_URXISEL0   BIT(6)
119 #define PIC32_UART_STA_ADDEN      BIT(5)
120 #define PIC32_UART_STA_RIDLE      BIT(4)
121 #define PIC32_UART_STA_PERR       BIT(3)
122 #define PIC32_UART_STA_FERR       BIT(2)
123 #define PIC32_UART_STA_OERR       BIT(1)
124 #define PIC32_UART_STA_URXDA      BIT(0)
125
126 #endif /* __DT_PIC32_UART_H__ */