Anton Vorontsov | aeec56e | 2010-10-27 15:33:15 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Basic memory-mapped GPIO controllers. |
| 3 | * |
| 4 | * Copyright 2008 MontaVista Software, Inc. |
| 5 | * Copyright 2008,2010 Anton Vorontsov <cbouatmailru@gmail.com> |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or modify it |
| 8 | * under the terms of the GNU General Public License as published by the |
| 9 | * Free Software Foundation; either version 2 of the License, or (at your |
| 10 | * option) any later version. |
| 11 | */ |
| 12 | |
| 13 | #ifndef __BASIC_MMIO_GPIO_H |
| 14 | #define __BASIC_MMIO_GPIO_H |
| 15 | |
Jamie Iles | 280df6b | 2011-05-20 00:40:19 -0600 | [diff] [blame] | 16 | #include <linux/gpio.h> |
| 17 | #include <linux/types.h> |
| 18 | #include <linux/compiler.h> |
Jamie Iles | e5ea3f1 | 2011-06-10 13:44:49 +0100 | [diff] [blame] | 19 | #include <linux/spinlock_types.h> |
Jamie Iles | 280df6b | 2011-05-20 00:40:19 -0600 | [diff] [blame] | 20 | |
Anton Vorontsov | aeec56e | 2010-10-27 15:33:15 -0700 | [diff] [blame] | 21 | struct bgpio_pdata { |
Pawel Moll | 781f6d7 | 2014-01-30 13:18:57 +0000 | [diff] [blame] | 22 | const char *label; |
Anton Vorontsov | aeec56e | 2010-10-27 15:33:15 -0700 | [diff] [blame] | 23 | int base; |
Jamie Iles | 924e7a9 | 2011-05-20 00:40:15 -0600 | [diff] [blame] | 24 | int ngpio; |
Anton Vorontsov | aeec56e | 2010-10-27 15:33:15 -0700 | [diff] [blame] | 25 | }; |
| 26 | |
Jamie Iles | 280df6b | 2011-05-20 00:40:19 -0600 | [diff] [blame] | 27 | struct device; |
| 28 | |
| 29 | struct bgpio_chip { |
| 30 | struct gpio_chip gc; |
| 31 | |
| 32 | unsigned long (*read_reg)(void __iomem *reg); |
| 33 | void (*write_reg)(void __iomem *reg, unsigned long data); |
| 34 | |
| 35 | void __iomem *reg_dat; |
| 36 | void __iomem *reg_set; |
| 37 | void __iomem *reg_clr; |
| 38 | void __iomem *reg_dir; |
| 39 | |
| 40 | /* Number of bits (GPIOs): <register width> * 8. */ |
| 41 | int bits; |
| 42 | |
| 43 | /* |
| 44 | * Some GPIO controllers work with the big-endian bits notation, |
| 45 | * e.g. in a 8-bits register, GPIO7 is the least significant bit. |
| 46 | */ |
| 47 | unsigned long (*pin2mask)(struct bgpio_chip *bgc, unsigned int pin); |
| 48 | |
| 49 | /* |
| 50 | * Used to lock bgpio_chip->data. Also, this is needed to keep |
| 51 | * shadowed and real data registers writes together. |
| 52 | */ |
| 53 | spinlock_t lock; |
| 54 | |
| 55 | /* Shadowed data register to clear/set bits safely. */ |
| 56 | unsigned long data; |
| 57 | |
| 58 | /* Shadowed direction registers to clear/set direction safely. */ |
| 59 | unsigned long dir; |
| 60 | }; |
| 61 | |
| 62 | static inline struct bgpio_chip *to_bgpio_chip(struct gpio_chip *gc) |
| 63 | { |
| 64 | return container_of(gc, struct bgpio_chip, gc); |
| 65 | } |
| 66 | |
Russell King | 4f5b048 | 2011-09-14 16:22:29 -0700 | [diff] [blame] | 67 | int bgpio_remove(struct bgpio_chip *bgc); |
| 68 | int bgpio_init(struct bgpio_chip *bgc, struct device *dev, |
| 69 | unsigned long sz, void __iomem *dat, void __iomem *set, |
| 70 | void __iomem *clr, void __iomem *dirout, void __iomem *dirin, |
Shawn Guo | 3e11f7b | 2012-05-19 21:34:58 +0800 | [diff] [blame] | 71 | unsigned long flags); |
| 72 | |
| 73 | #define BGPIOF_BIG_ENDIAN BIT(0) |
| 74 | #define BGPIOF_UNREADABLE_REG_SET BIT(1) /* reg_set is unreadable */ |
| 75 | #define BGPIOF_UNREADABLE_REG_DIR BIT(2) /* reg_dir is unreadable */ |
Andreas Larsson | 2b78f1e | 2013-03-15 14:45:38 +0100 | [diff] [blame] | 76 | #define BGPIOF_BIG_ENDIAN_BYTE_ORDER BIT(3) |
Vladimir Zapolskiy | b19e7f5 | 2015-04-29 18:34:59 +0300 | [diff] [blame] | 77 | #define BGPIOF_READ_OUTPUT_REG_SET BIT(4) /* reg_set stores output value */ |
Jamie Iles | 280df6b | 2011-05-20 00:40:19 -0600 | [diff] [blame] | 78 | |
Anton Vorontsov | aeec56e | 2010-10-27 15:33:15 -0700 | [diff] [blame] | 79 | #endif /* __BASIC_MMIO_GPIO_H */ |