1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * at91_cf.c -- AT91 CompactFlash controller driver
5 * Copyright (C) 2005 David Brownell
8 #include <linux/module.h>
9 #include <linux/kernel.h>
10 #include <linux/platform_device.h>
11 #include <linux/errno.h>
12 #include <linux/init.h>
13 #include <linux/interrupt.h>
14 #include <linux/slab.h>
15 #include <linux/gpio.h>
17 #include <linux/sizes.h>
18 #include <linux/mfd/syscon.h>
19 #include <linux/mfd/syscon/atmel-mc.h>
21 #include <linux/of_device.h>
22 #include <linux/of_gpio.h>
23 #include <linux/regmap.h>
25 #include <pcmcia/ss.h>
28 * A0..A10 work in each range; A23 indicates I/O space; A25 is CFRNW;
29 * some other bit in {A24,A22..A11} is nREG to flag memory access
30 * (vs attributes). So more than 2KB/region would just be waste.
31 * Note: These are offsets from the physical base address.
33 #define CF_ATTR_PHYS (0)
34 #define CF_IO_PHYS (1 << 23)
35 #define CF_MEM_PHYS (0x017ff800)
38 int irq_pin; /* I/O IRQ */
39 int det_pin; /* Card detect */
40 int vcc_pin; /* power switching */
41 int rst_pin; /* card reset */
42 u8 chipselect; /* EBI Chip Select number */
44 #define AT91_CF_TRUE_IDE 0x01
45 #define AT91_IDE_SWAP_A0_A2 0x02
50 /*--------------------------------------------------------------------------*/
52 struct at91_cf_socket {
53 struct pcmcia_socket socket;
57 struct platform_device *pdev;
58 struct at91_cf_data *board;
60 unsigned long phys_baseaddr;
63 static inline int at91_cf_present(struct at91_cf_socket *cf)
65 return !gpio_get_value(cf->board->det_pin);
68 /*--------------------------------------------------------------------------*/
70 static int at91_cf_ss_init(struct pcmcia_socket *s)
75 static irqreturn_t at91_cf_irq(int irq, void *_cf)
77 struct at91_cf_socket *cf = _cf;
79 if (irq == gpio_to_irq(cf->board->det_pin)) {
80 unsigned present = at91_cf_present(cf);
82 /* kick pccard as needed */
83 if (present != cf->present) {
84 cf->present = present;
85 dev_dbg(&cf->pdev->dev, "card %s\n",
86 present ? "present" : "gone");
87 pcmcia_parse_events(&cf->socket, SS_DETECT);
94 static int at91_cf_get_status(struct pcmcia_socket *s, u_int *sp)
96 struct at91_cf_socket *cf;
101 cf = container_of(s, struct at91_cf_socket, socket);
103 /* NOTE: CF is always 3VCARD */
104 if (at91_cf_present(cf)) {
105 int rdy = gpio_is_valid(cf->board->irq_pin); /* RDY/nIRQ */
106 int vcc = gpio_is_valid(cf->board->vcc_pin);
108 *sp = SS_DETECT | SS_3VCARD;
109 if (!rdy || gpio_get_value(cf->board->irq_pin))
111 if (!vcc || gpio_get_value(cf->board->vcc_pin))
120 at91_cf_set_socket(struct pcmcia_socket *sock, struct socket_state_t *s)
122 struct at91_cf_socket *cf;
124 cf = container_of(sock, struct at91_cf_socket, socket);
126 /* switch Vcc if needed and possible */
127 if (gpio_is_valid(cf->board->vcc_pin)) {
130 gpio_set_value(cf->board->vcc_pin, 0);
133 gpio_set_value(cf->board->vcc_pin, 1);
140 /* toggle reset if needed */
141 gpio_set_value(cf->board->rst_pin, s->flags & SS_RESET);
143 dev_dbg(&cf->pdev->dev, "Vcc %d, io_irq %d, flags %04x csc %04x\n",
144 s->Vcc, s->io_irq, s->flags, s->csc_mask);
149 static int at91_cf_ss_suspend(struct pcmcia_socket *s)
151 return at91_cf_set_socket(s, &dead_socket);
154 /* we already mapped the I/O region */
155 static int at91_cf_set_io_map(struct pcmcia_socket *s, struct pccard_io_map *io)
157 struct at91_cf_socket *cf;
160 cf = container_of(s, struct at91_cf_socket, socket);
161 io->flags &= (MAP_ACTIVE | MAP_16BIT | MAP_AUTOSZ);
164 * Use 16 bit accesses unless/until we need 8-bit i/o space.
166 * NOTE: this CF controller ignores IOIS16, so we can't really do
167 * MAP_AUTOSZ. The 16bit mode allows single byte access on either
168 * D0-D7 (even addr) or D8-D15 (odd), so it's close enough for many
169 * purposes (and handles ide-cs).
171 * The 8bit mode is needed for odd byte access on D0-D7. It seems
172 * some cards only like that way to get at the odd byte, despite
173 * CF 3.0 spec table 35 also giving the D8-D15 option.
175 if (!(io->flags & (MAP_16BIT | MAP_AUTOSZ))) {
176 csr = AT91_MC_SMC_DBW_8;
177 dev_dbg(&cf->pdev->dev, "8bit i/o bus\n");
179 csr = AT91_MC_SMC_DBW_16;
180 dev_dbg(&cf->pdev->dev, "16bit i/o bus\n");
182 regmap_update_bits(mc, AT91_MC_SMC_CSR(cf->board->chipselect),
183 AT91_MC_SMC_DBW, csr);
185 io->start = cf->socket.io_offset;
186 io->stop = io->start + SZ_2K - 1;
191 /* pcmcia layer maps/unmaps mem regions */
193 at91_cf_set_mem_map(struct pcmcia_socket *s, struct pccard_mem_map *map)
195 struct at91_cf_socket *cf;
200 cf = container_of(s, struct at91_cf_socket, socket);
202 map->flags &= (MAP_ACTIVE | MAP_ATTRIB | MAP_16BIT);
203 if (map->flags & MAP_ATTRIB)
204 map->static_start = cf->phys_baseaddr + CF_ATTR_PHYS;
206 map->static_start = cf->phys_baseaddr + CF_MEM_PHYS;
211 static struct pccard_operations at91_cf_ops = {
212 .init = at91_cf_ss_init,
213 .suspend = at91_cf_ss_suspend,
214 .get_status = at91_cf_get_status,
215 .set_socket = at91_cf_set_socket,
216 .set_io_map = at91_cf_set_io_map,
217 .set_mem_map = at91_cf_set_mem_map,
220 /*--------------------------------------------------------------------------*/
222 #if defined(CONFIG_OF)
223 static const struct of_device_id at91_cf_dt_ids[] = {
224 { .compatible = "atmel,at91rm9200-cf" },
227 MODULE_DEVICE_TABLE(of, at91_cf_dt_ids);
229 static int at91_cf_dt_init(struct platform_device *pdev)
231 struct at91_cf_data *board;
233 board = devm_kzalloc(&pdev->dev, sizeof(*board), GFP_KERNEL);
237 board->irq_pin = of_get_gpio(pdev->dev.of_node, 0);
238 board->det_pin = of_get_gpio(pdev->dev.of_node, 1);
239 board->vcc_pin = of_get_gpio(pdev->dev.of_node, 2);
240 board->rst_pin = of_get_gpio(pdev->dev.of_node, 3);
242 pdev->dev.platform_data = board;
244 mc = syscon_regmap_lookup_by_compatible("atmel,at91rm9200-sdramc");
246 return PTR_ERR_OR_ZERO(mc);
249 static int at91_cf_dt_init(struct platform_device *pdev)
255 static int at91_cf_probe(struct platform_device *pdev)
257 struct at91_cf_socket *cf;
258 struct at91_cf_data *board = pdev->dev.platform_data;
263 status = at91_cf_dt_init(pdev);
267 board = pdev->dev.platform_data;
270 if (!gpio_is_valid(board->det_pin) || !gpio_is_valid(board->rst_pin))
273 io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
277 cf = devm_kzalloc(&pdev->dev, sizeof(*cf), GFP_KERNEL);
283 cf->phys_baseaddr = io->start;
284 platform_set_drvdata(pdev, cf);
286 /* must be a GPIO; ergo must trigger on both edges */
287 status = devm_gpio_request(&pdev->dev, board->det_pin, "cf_det");
291 status = devm_request_irq(&pdev->dev, gpio_to_irq(board->det_pin),
292 at91_cf_irq, 0, "at91_cf detect", cf);
296 device_init_wakeup(&pdev->dev, 1);
298 status = devm_gpio_request(&pdev->dev, board->rst_pin, "cf_rst");
302 if (gpio_is_valid(board->vcc_pin)) {
303 status = devm_gpio_request(&pdev->dev, board->vcc_pin, "cf_vcc");
309 * The card driver will request this irq later as needed.
310 * but it causes lots of "irqNN: nobody cared" messages
311 * unless we report that we handle everything (sigh).
312 * (Note: DK board doesn't wire the IRQ pin...)
314 if (gpio_is_valid(board->irq_pin)) {
315 status = devm_gpio_request(&pdev->dev, board->irq_pin, "cf_irq");
319 status = devm_request_irq(&pdev->dev, gpio_to_irq(board->irq_pin),
320 at91_cf_irq, IRQF_SHARED, "at91_cf", cf);
323 cf->socket.pci_irq = gpio_to_irq(board->irq_pin);
325 cf->socket.pci_irq = nr_irqs + 1;
328 * pcmcia layer only remaps "real" memory not iospace
329 * io_offset is set to 0x10000 to avoid the check in static_find_io().
331 cf->socket.io_offset = 0x10000;
332 status = pci_ioremap_io(0x10000, cf->phys_baseaddr + CF_IO_PHYS);
336 /* reserve chip-select regions */
337 if (!devm_request_mem_region(&pdev->dev, io->start, resource_size(io), "at91_cf")) {
342 dev_info(&pdev->dev, "irqs det #%d, io #%d\n",
343 gpio_to_irq(board->det_pin), gpio_to_irq(board->irq_pin));
345 cf->socket.owner = THIS_MODULE;
346 cf->socket.dev.parent = &pdev->dev;
347 cf->socket.ops = &at91_cf_ops;
348 cf->socket.resource_ops = &pccard_static_ops;
349 cf->socket.features = SS_CAP_PCCARD | SS_CAP_STATIC_MAP
351 cf->socket.map_size = SZ_2K;
352 cf->socket.io[0].res = io;
354 status = pcmcia_register_socket(&cf->socket);
361 device_init_wakeup(&pdev->dev, 0);
365 static int at91_cf_remove(struct platform_device *pdev)
367 struct at91_cf_socket *cf = platform_get_drvdata(pdev);
369 pcmcia_unregister_socket(&cf->socket);
370 device_init_wakeup(&pdev->dev, 0);
377 static int at91_cf_suspend(struct platform_device *pdev, pm_message_t mesg)
379 struct at91_cf_socket *cf = platform_get_drvdata(pdev);
380 struct at91_cf_data *board = cf->board;
382 if (device_may_wakeup(&pdev->dev)) {
383 enable_irq_wake(gpio_to_irq(board->det_pin));
384 if (gpio_is_valid(board->irq_pin))
385 enable_irq_wake(gpio_to_irq(board->irq_pin));
390 static int at91_cf_resume(struct platform_device *pdev)
392 struct at91_cf_socket *cf = platform_get_drvdata(pdev);
393 struct at91_cf_data *board = cf->board;
395 if (device_may_wakeup(&pdev->dev)) {
396 disable_irq_wake(gpio_to_irq(board->det_pin));
397 if (gpio_is_valid(board->irq_pin))
398 disable_irq_wake(gpio_to_irq(board->irq_pin));
405 #define at91_cf_suspend NULL
406 #define at91_cf_resume NULL
409 static struct platform_driver at91_cf_driver = {
412 .of_match_table = of_match_ptr(at91_cf_dt_ids),
414 .probe = at91_cf_probe,
415 .remove = at91_cf_remove,
416 .suspend = at91_cf_suspend,
417 .resume = at91_cf_resume,
420 module_platform_driver(at91_cf_driver);
422 MODULE_DESCRIPTION("AT91 Compact Flash Driver");
423 MODULE_AUTHOR("David Brownell");
424 MODULE_LICENSE("GPL");
425 MODULE_ALIAS("platform:at91_cf");