1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/bitfield.h>
4 #include <linux/bitops.h>
5 #include <linux/device.h>
6 #include <linux/gpio/driver.h>
8 #include <linux/ioport.h>
9 #include <linux/kernel.h>
10 #include <linux/mod_devicetable.h>
11 #include <linux/module.h>
12 #include <linux/platform_device.h>
14 #include <linux/resource.h>
15 #include <linux/spinlock.h>
16 #include <linux/types.h>
19 * There are 3 YU GPIO blocks:
20 * gpio[0]: HOST_GPIO0->HOST_GPIO31
21 * gpio[1]: HOST_GPIO32->HOST_GPIO63
22 * gpio[2]: HOST_GPIO64->HOST_GPIO69
24 #define MLXBF2_GPIO_MAX_PINS_PER_BLOCK 32
27 * arm_gpio_lock register:
28 * bit[31] lock status: active if set
30 * The lock is enabled only if 0xd42f is written to this field
32 #define YU_ARM_GPIO_LOCK_ADDR 0x2801088
33 #define YU_ARM_GPIO_LOCK_SIZE 0x8
34 #define YU_LOCK_ACTIVE_BIT(val) (val >> 31)
35 #define YU_ARM_GPIO_LOCK_ACQUIRE 0xd42f
36 #define YU_ARM_GPIO_LOCK_RELEASE 0x0
39 * gpio[x] block registers and their offset
41 #define YU_GPIO_DATAIN 0x04
42 #define YU_GPIO_MODE1 0x08
43 #define YU_GPIO_MODE0 0x0c
44 #define YU_GPIO_DATASET 0x14
45 #define YU_GPIO_DATACLEAR 0x18
46 #define YU_GPIO_MODE1_CLEAR 0x50
47 #define YU_GPIO_MODE0_SET 0x54
48 #define YU_GPIO_MODE0_CLEAR 0x58
50 struct mlxbf2_gpio_context_save_regs
{
55 /* BlueField-2 gpio block context structure. */
56 struct mlxbf2_gpio_context
{
59 /* YU GPIO blocks address */
60 void __iomem
*gpio_io
;
62 struct mlxbf2_gpio_context_save_regs
*csave_regs
;
65 /* BlueField-2 gpio shared structure. */
66 struct mlxbf2_gpio_param
{
72 static struct resource yu_arm_gpio_lock_res
=
73 DEFINE_RES_MEM_NAMED(YU_ARM_GPIO_LOCK_ADDR
, YU_ARM_GPIO_LOCK_SIZE
, "YU_ARM_GPIO_LOCK");
75 static DEFINE_MUTEX(yu_arm_gpio_lock_mutex
);
77 static struct mlxbf2_gpio_param yu_arm_gpio_lock_param
= {
78 .res
= &yu_arm_gpio_lock_res
,
79 .lock
= &yu_arm_gpio_lock_mutex
,
82 /* Request memory region and map yu_arm_gpio_lock resource */
83 static int mlxbf2_gpio_get_lock_res(struct platform_device
*pdev
)
85 struct device
*dev
= &pdev
->dev
;
90 mutex_lock(yu_arm_gpio_lock_param
.lock
);
92 /* Check if the memory map already exists */
93 if (yu_arm_gpio_lock_param
.io
)
96 res
= yu_arm_gpio_lock_param
.res
;
97 size
= resource_size(res
);
99 if (!devm_request_mem_region(dev
, res
->start
, size
, res
->name
)) {
104 yu_arm_gpio_lock_param
.io
= devm_ioremap(dev
, res
->start
, size
);
105 if (!yu_arm_gpio_lock_param
.io
)
109 mutex_unlock(yu_arm_gpio_lock_param
.lock
);
115 * Acquire the YU arm_gpio_lock to be able to change the direction
116 * mode. If the lock_active bit is already set, return an error.
118 static int mlxbf2_gpio_lock_acquire(struct mlxbf2_gpio_context
*gs
)
120 u32 arm_gpio_lock_val
;
122 mutex_lock(yu_arm_gpio_lock_param
.lock
);
123 spin_lock(&gs
->gc
.bgpio_lock
);
125 arm_gpio_lock_val
= readl(yu_arm_gpio_lock_param
.io
);
128 * When lock active bit[31] is set, ModeX is write enabled
130 if (YU_LOCK_ACTIVE_BIT(arm_gpio_lock_val
)) {
131 spin_unlock(&gs
->gc
.bgpio_lock
);
132 mutex_unlock(yu_arm_gpio_lock_param
.lock
);
136 writel(YU_ARM_GPIO_LOCK_ACQUIRE
, yu_arm_gpio_lock_param
.io
);
142 * Release the YU arm_gpio_lock after changing the direction mode.
144 static void mlxbf2_gpio_lock_release(struct mlxbf2_gpio_context
*gs
)
145 __releases(&gs
->gc
.bgpio_lock
)
146 __releases(yu_arm_gpio_lock_param
.lock
)
148 writel(YU_ARM_GPIO_LOCK_RELEASE
, yu_arm_gpio_lock_param
.io
);
149 spin_unlock(&gs
->gc
.bgpio_lock
);
150 mutex_unlock(yu_arm_gpio_lock_param
.lock
);
154 * mode0 and mode1 are both locked by the gpio_lock field.
156 * Together, mode0 and mode1 define the gpio Mode dependeing also
159 * {mode1,mode0}:{Reg_DataOut=0,Reg_DataOut=1}->{DataOut=0,DataOut=1}
161 * {0,0}:Reg_DataOut{0,1}->{Z,Z} Input PAD
162 * {0,1}:Reg_DataOut{0,1}->{0,1} Full drive Output PAD
163 * {1,0}:Reg_DataOut{0,1}->{0,Z} 0-set PAD to low, 1-float
164 * {1,1}:Reg_DataOut{0,1}->{Z,1} 0-float, 1-set PAD to high
168 * Set input direction:
169 * {mode1,mode0} = {0,0}
171 static int mlxbf2_gpio_direction_input(struct gpio_chip
*chip
,
174 struct mlxbf2_gpio_context
*gs
= gpiochip_get_data(chip
);
178 * Although the arm_gpio_lock was set in the probe function, check again
179 * if it is still enabled to be able to write to the ModeX registers.
181 ret
= mlxbf2_gpio_lock_acquire(gs
);
185 writel(BIT(offset
), gs
->gpio_io
+ YU_GPIO_MODE0_CLEAR
);
186 writel(BIT(offset
), gs
->gpio_io
+ YU_GPIO_MODE1_CLEAR
);
188 mlxbf2_gpio_lock_release(gs
);
194 * Set output direction:
195 * {mode1,mode0} = {0,1}
197 static int mlxbf2_gpio_direction_output(struct gpio_chip
*chip
,
201 struct mlxbf2_gpio_context
*gs
= gpiochip_get_data(chip
);
205 * Although the arm_gpio_lock was set in the probe function,
206 * check again it is still enabled to be able to write to the
209 ret
= mlxbf2_gpio_lock_acquire(gs
);
213 writel(BIT(offset
), gs
->gpio_io
+ YU_GPIO_MODE1_CLEAR
);
214 writel(BIT(offset
), gs
->gpio_io
+ YU_GPIO_MODE0_SET
);
216 mlxbf2_gpio_lock_release(gs
);
221 /* BlueField-2 GPIO driver initialization routine. */
223 mlxbf2_gpio_probe(struct platform_device
*pdev
)
225 struct mlxbf2_gpio_context
*gs
;
226 struct device
*dev
= &pdev
->dev
;
227 struct gpio_chip
*gc
;
231 gs
= devm_kzalloc(dev
, sizeof(*gs
), GFP_KERNEL
);
235 /* YU GPIO block address */
236 gs
->gpio_io
= devm_platform_ioremap_resource(pdev
, 0);
237 if (IS_ERR(gs
->gpio_io
))
238 return PTR_ERR(gs
->gpio_io
);
240 ret
= mlxbf2_gpio_get_lock_res(pdev
);
242 dev_err(dev
, "Failed to get yu_arm_gpio_lock resource\n");
246 if (device_property_read_u32(dev
, "npins", &npins
))
247 npins
= MLXBF2_GPIO_MAX_PINS_PER_BLOCK
;
251 ret
= bgpio_init(gc
, dev
, 4,
252 gs
->gpio_io
+ YU_GPIO_DATAIN
,
253 gs
->gpio_io
+ YU_GPIO_DATASET
,
254 gs
->gpio_io
+ YU_GPIO_DATACLEAR
,
259 gc
->direction_input
= mlxbf2_gpio_direction_input
;
260 gc
->direction_output
= mlxbf2_gpio_direction_output
;
262 gc
->owner
= THIS_MODULE
;
264 platform_set_drvdata(pdev
, gs
);
266 ret
= devm_gpiochip_add_data(dev
, &gs
->gc
, gs
);
268 dev_err(dev
, "Failed adding memory mapped gpiochip\n");
275 static int __maybe_unused
mlxbf2_gpio_suspend(struct device
*dev
)
277 struct mlxbf2_gpio_context
*gs
= dev_get_drvdata(dev
);
279 gs
->csave_regs
->gpio_mode0
= readl(gs
->gpio_io
+
281 gs
->csave_regs
->gpio_mode1
= readl(gs
->gpio_io
+
287 static int __maybe_unused
mlxbf2_gpio_resume(struct device
*dev
)
289 struct mlxbf2_gpio_context
*gs
= dev_get_drvdata(dev
);
291 writel(gs
->csave_regs
->gpio_mode0
, gs
->gpio_io
+
293 writel(gs
->csave_regs
->gpio_mode1
, gs
->gpio_io
+
298 static SIMPLE_DEV_PM_OPS(mlxbf2_pm_ops
, mlxbf2_gpio_suspend
, mlxbf2_gpio_resume
);
300 static const struct acpi_device_id __maybe_unused mlxbf2_gpio_acpi_match
[] = {
304 MODULE_DEVICE_TABLE(acpi
, mlxbf2_gpio_acpi_match
);
306 static struct platform_driver mlxbf2_gpio_driver
= {
308 .name
= "mlxbf2_gpio",
309 .acpi_match_table
= mlxbf2_gpio_acpi_match
,
310 .pm
= &mlxbf2_pm_ops
,
312 .probe
= mlxbf2_gpio_probe
,
315 module_platform_driver(mlxbf2_gpio_driver
);
317 MODULE_DESCRIPTION("Mellanox BlueField-2 GPIO Driver");
318 MODULE_AUTHOR("Mellanox Technologies");
319 MODULE_LICENSE("GPL v2");