sdio: core support for SDIO function interrupt
[safe/jmp/linux-2.6] / include / linux / mmc / sdio_func.h
1 /*
2  *  include/linux/mmc/sdio_func.h
3  *
4  *  Copyright 2007 Pierre Ossman
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or (at
9  * your option) any later version.
10  */
11
12 #ifndef MMC_SDIO_FUNC_H
13 #define MMC_SDIO_FUNC_H
14
15 #include <linux/device.h>
16 #include <linux/mod_devicetable.h>
17
18 struct mmc_card;
19 struct sdio_func;
20
21 typedef void (sdio_irq_handler_t)(struct sdio_func *);
22
23 /*
24  * SDIO function CIS tuple (unknown to the core)
25  */
26 struct sdio_func_tuple {
27         struct sdio_func_tuple *next;
28         unsigned char code;
29         unsigned char size;
30         unsigned char data[0];
31 };
32
33 /*
34  * SDIO function devices
35  */
36 struct sdio_func {
37         struct mmc_card         *card;          /* the card this device belongs to */
38         struct device           dev;            /* the device */
39         sdio_irq_handler_t      *irq_handler;   /* IRQ callback */
40         unsigned int            num;            /* function number */
41
42         unsigned char           class;          /* standard interface class */
43         unsigned short          vendor;         /* vendor id */
44         unsigned short          device;         /* device id */
45
46         unsigned short          blksize;        /* maximum block size */
47
48         unsigned int            state;          /* function state */
49 #define SDIO_STATE_PRESENT      (1<<0)          /* present in sysfs */
50
51         struct sdio_func_tuple *tuples;
52 };
53
54 #define sdio_func_present(f)    ((f)->state & SDIO_STATE_PRESENT)
55
56 #define sdio_func_set_present(f) ((f)->state |= SDIO_STATE_PRESENT)
57
58 #define sdio_func_id(f)         ((f)->dev.bus_id)
59
60 #define sdio_get_drvdata(f)     dev_get_drvdata(&(f)->dev)
61 #define sdio_set_drvdata(f,d)   dev_set_drvdata(&(f)->dev, d)
62
63 /*
64  * SDIO function device driver
65  */
66 struct sdio_driver {
67         char *name;
68         const struct sdio_device_id *id_table;
69
70         int (*probe)(struct sdio_func *, const struct sdio_device_id *);
71         void (*remove)(struct sdio_func *);
72
73         struct device_driver drv;
74 };
75
76 /**
77  * SDIO_DEVICE - macro used to describe a specific SDIO device
78  * @vend: the 16 bit manufacturer code
79  * @dev: the 16 bit function id
80  *
81  * This macro is used to create a struct sdio_device_id that matches a
82  * specific device. The class field will be set to SDIO_ANY_ID.
83  */
84 #define SDIO_DEVICE(vend,dev) \
85         .class = SDIO_ANY_ID, \
86         .vendor = (vend), .device = (dev)
87
88 /**
89  * SDIO_DEVICE_CLASS - macro used to describe a specific SDIO device class
90  * @dev_class: the 8 bit standard interface code
91  *
92  * This macro is used to create a struct sdio_device_id that matches a
93  * specific standard SDIO function type.  The vendor and device fields will
94  * be set to SDIO_ANY_ID.
95  */
96 #define SDIO_DEVICE_CLASS(dev_class) \
97         .class = (dev_class), \
98         .vendor = SDIO_ANY_ID, .device = SDIO_ANY_ID
99
100 extern int sdio_register_driver(struct sdio_driver *);
101 extern void sdio_unregister_driver(struct sdio_driver *);
102
103 /*
104  * SDIO I/O operations
105  */
106 extern void sdio_claim_host(struct sdio_func *func);
107 extern void sdio_release_host(struct sdio_func *func);
108
109 extern int sdio_enable_func(struct sdio_func *func);
110 extern int sdio_disable_func(struct sdio_func *func);
111
112 extern int sdio_claim_irq(struct sdio_func *func, sdio_irq_handler_t *handler);
113 extern int sdio_release_irq(struct sdio_func *func);
114
115 extern unsigned char sdio_readb(struct sdio_func *func,
116         unsigned int addr, int *err_ret);
117
118 extern void sdio_writeb(struct sdio_func *func, unsigned char b,
119         unsigned int addr, int *err_ret);
120
121 #endif
122