mxs_gpio: correctly use the GPIO API
[karo-tx-uboot.git] / arch / arm / include / asm / arch-mxs / iomux.h
1 /*
2  * Copyright (C) 2009 by Jan Weitzel Phytec Messtechnik GmbH,
3  *                      <armlinux@phytec.de>
4  * Copyright (C) 2010 Freescale Semiconductor, Inc. All Rights Reserved.
5  *
6  * SPDX-License-Identifier:     GPL-2.0+
7  */
8
9 #ifndef __MACH_MXS_IOMUX_H__
10 #define __MACH_MXS_IOMUX_H__
11
12 #ifndef __ASSEMBLY__
13
14 #include <asm/types.h>
15
16 /*
17  * IOMUX/PAD Bit field definitions
18  *
19  * PAD_BANK:             0..2   (3)
20  * PAD_PIN:              3..7   (5)
21  * PAD_MUXSEL:           8..9   (2)
22  * PAD_MA:              10..11  (2)
23  * PAD_MA_VALID:        12      (1)
24  * PAD_VOL:             13      (1)
25  * PAD_VOL_VALID:       14      (1)
26  * PAD_PULL:            15      (1)
27  * PAD_PULL_VALID:      16      (1)
28  * RESERVED:            17..30  (14)
29  * sentinel to produce an invalid GPIO number when using an
30  * iomux_cfg_t value where a plain GPIO number is expected
31  * GPIO_SENTINEL:       31      (1)
32  */
33 #ifdef CONFIG_MXS_IOMUX_COMPILE_CHECK
34 typedef u64 iomux_cfg_t;
35 #define IOMUX_CFG_SHIFT         32
36 #else
37 typedef u32 iomux_cfg_t;
38 #define IOMUX_CFG_SHIFT         0
39 #endif
40
41 #define MXS_PAD_BANK_SHIFT      (IOMUX_CFG_SHIFT + 0)
42 #define MXS_PAD_BANK_MASK       ((iomux_cfg_t)0x7 << MXS_PAD_BANK_SHIFT)
43 #define MXS_PAD_PIN_SHIFT       (IOMUX_CFG_SHIFT + 3)
44 #define MXS_PAD_PIN_MASK        ((iomux_cfg_t)0x1f << MXS_PAD_PIN_SHIFT)
45 #define MXS_PAD_MUXSEL_SHIFT    (IOMUX_CFG_SHIFT + 8)
46 #define MXS_PAD_MUXSEL_MASK     ((iomux_cfg_t)0x3 << MXS_PAD_MUXSEL_SHIFT)
47 #define MXS_PAD_MA_SHIFT        (IOMUX_CFG_SHIFT + 10)
48 #define MXS_PAD_MA_MASK         ((iomux_cfg_t)0x3 << MXS_PAD_MA_SHIFT)
49 #define MXS_PAD_MA_VALID_SHIFT  (IOMUX_CFG_SHIFT + 12)
50 #define MXS_PAD_MA_VALID_MASK   ((iomux_cfg_t)0x1 << MXS_PAD_MA_VALID_SHIFT)
51 #define MXS_PAD_VOL_SHIFT       (IOMUX_CFG_SHIFT + 13)
52 #define MXS_PAD_VOL_MASK        ((iomux_cfg_t)0x1 << MXS_PAD_VOL_SHIFT)
53 #define MXS_PAD_VOL_VALID_SHIFT (IOMUX_CFG_SHIFT + 14)
54 #define MXS_PAD_VOL_VALID_MASK  ((iomux_cfg_t)0x1 << MXS_PAD_VOL_VALID_SHIFT)
55 #define MXS_PAD_PULL_SHIFT      (IOMUX_CFG_SHIFT + 15)
56 #define MXS_PAD_PULL_MASK       ((iomux_cfg_t)0x1 << MXS_PAD_PULL_SHIFT)
57 #define MXS_PAD_PULL_VALID_SHIFT (IOMUX_CFG_SHIFT + 16)
58 #define MXS_PAD_PULL_VALID_MASK ((iomux_cfg_t)0x1 << MXS_PAD_PULL_VALID_SHIFT)
59
60 #define MXS_GPIO_SENTINEL_SHIFT (IOMUX_CFG_SHIFT + 31)
61 #define MXS_GPIO_SENTINEL_MASK  ((iomux_cfg_t)0x1 << MXS_GPIO_SENTINEL_SHIFT)
62
63 #define PAD_MUXSEL_0            (iomux_cfg_t)0
64 #define PAD_MUXSEL_1            (iomux_cfg_t)1
65 #define PAD_MUXSEL_2            (iomux_cfg_t)2
66 #define PAD_MUXSEL_GPIO         (iomux_cfg_t)3
67
68 #define PAD_4MA                 (iomux_cfg_t)0
69 #define PAD_8MA                 (iomux_cfg_t)1
70 #define PAD_12MA                (iomux_cfg_t)2
71 #define PAD_16MA                (iomux_cfg_t)3
72
73 #define PAD_1V8                 (iomux_cfg_t)0
74 #if defined(CONFIG_SOC_MX28)
75 #define PAD_3V3                 (iomux_cfg_t)1
76 #else
77 #define PAD_3V3                 (iomux_cfg_t)0
78 #endif
79
80 #define PAD_NOPULL              (iomux_cfg_t)0
81 #define PAD_PULLUP              (iomux_cfg_t)1
82
83 #define MXS_PAD_4MA     ((PAD_4MA << MXS_PAD_MA_SHIFT) | \
84                                         MXS_PAD_MA_VALID_MASK)
85 #define MXS_PAD_8MA     ((PAD_8MA << MXS_PAD_MA_SHIFT) | \
86                                         MXS_PAD_MA_VALID_MASK)
87 #define MXS_PAD_12MA    ((PAD_12MA << MXS_PAD_MA_SHIFT) | \
88                                         MXS_PAD_MA_VALID_MASK)
89 #define MXS_PAD_16MA    ((PAD_16MA << MXS_PAD_MA_SHIFT) | \
90                                         MXS_PAD_MA_VALID_MASK)
91
92 #define MXS_PAD_1V8     ((PAD_1V8 << MXS_PAD_VOL_SHIFT) | \
93                                         MXS_PAD_VOL_VALID_MASK)
94 #define MXS_PAD_3V3     ((PAD_3V3 << MXS_PAD_VOL_SHIFT) | \
95                                         MXS_PAD_VOL_VALID_MASK)
96
97 #define MXS_PAD_NOPULL  ((PAD_NOPULL << MXS_PAD_PULL_SHIFT) | \
98                                         MXS_PAD_PULL_VALID_MASK)
99 #define MXS_PAD_PULLUP  ((PAD_PULLUP << MXS_PAD_PULL_SHIFT) | \
100                                         MXS_PAD_PULL_VALID_MASK)
101
102 /* generic pad control used in most cases */
103 #define MXS_PAD_CTRL    (MXS_PAD_4MA | MXS_PAD_3V3 | MXS_PAD_NOPULL)
104
105 #define MXS_IOMUX_PAD(_bank, _pin, _muxsel, _ma, _vol, _pull)           \
106                 (((iomux_cfg_t)(_bank) << MXS_PAD_BANK_SHIFT) |         \
107                 ((iomux_cfg_t)(_pin) << MXS_PAD_PIN_SHIFT) |            \
108                 ((iomux_cfg_t)(_muxsel) << MXS_PAD_MUXSEL_SHIFT) |      \
109                 ((iomux_cfg_t)(_ma) << MXS_PAD_MA_SHIFT) |              \
110                 ((iomux_cfg_t)(_vol) << MXS_PAD_VOL_SHIFT) |            \
111                 ((iomux_cfg_t)(_pull) << MXS_PAD_PULL_SHIFT) |          \
112                 ((iomux_cfg_t)1 << 31))
113
114 #define MXS_PAD_TO_GPIO(p)      ((unsigned)(((((p) & MXS_PAD_BANK_MASK) >> \
115                                         MXS_PAD_BANK_SHIFT) << 5) |     \
116                                         ((p) & MXS_PAD_PIN_MASK) >>     \
117                                         MXS_PAD_PIN_SHIFT))
118
119 /*
120  * A pad becomes naked, when none of mA, vol or pull
121  * validity bits is set.
122  */
123 #define MXS_IOMUX_PAD_NAKED(_bank, _pin, _muxsel) \
124                 MXS_IOMUX_PAD(_bank, _pin, _muxsel, 0, 0, 0)
125
126 static inline unsigned int PAD_BANK(iomux_cfg_t pad)
127 {
128         return (pad & MXS_PAD_BANK_MASK) >> MXS_PAD_BANK_SHIFT;
129 }
130
131 static inline unsigned int PAD_PIN(iomux_cfg_t pad)
132 {
133         return (pad & MXS_PAD_PIN_MASK) >> MXS_PAD_PIN_SHIFT;
134 }
135
136 static inline unsigned int PAD_MUXSEL(iomux_cfg_t pad)
137 {
138         return (pad & MXS_PAD_MUXSEL_MASK) >> MXS_PAD_MUXSEL_SHIFT;
139 }
140
141 static inline unsigned int PAD_MA(iomux_cfg_t pad)
142 {
143         return (pad & MXS_PAD_MA_MASK) >> MXS_PAD_MA_SHIFT;
144 }
145
146 static inline unsigned int PAD_MA_VALID(iomux_cfg_t pad)
147 {
148         return (pad & MXS_PAD_MA_VALID_MASK) >> MXS_PAD_MA_VALID_SHIFT;
149 }
150
151 static inline unsigned int PAD_VOL(iomux_cfg_t pad)
152 {
153         return (pad & MXS_PAD_VOL_MASK) >> MXS_PAD_VOL_SHIFT;
154 }
155
156 static inline unsigned int PAD_VOL_VALID(iomux_cfg_t pad)
157 {
158         return (pad & MXS_PAD_VOL_VALID_MASK) >> MXS_PAD_VOL_VALID_SHIFT;
159 }
160
161 static inline unsigned int PAD_PULL(iomux_cfg_t pad)
162 {
163         return (pad & MXS_PAD_PULL_MASK) >> MXS_PAD_PULL_SHIFT;
164 }
165
166 static inline unsigned int PAD_PULL_VALID(iomux_cfg_t pad)
167 {
168         return (pad & MXS_PAD_PULL_VALID_MASK) >> MXS_PAD_PULL_VALID_SHIFT;
169 }
170
171 /*
172  * configures a single pad in the iomuxer
173  */
174 int mxs_iomux_setup_pad(iomux_cfg_t pad);
175
176 /*
177  * configures multiple pads
178  * convenient way to call the above function with tables
179  */
180 int mxs_iomux_setup_multiple_pads(const iomux_cfg_t *pad_list, unsigned count);
181
182 #endif /* __ASSEMBLY__ */
183 #endif /* __MACH_MXS_IOMUX_H__*/