mmc: export eMMC4.4 enhanced area details to sysfs
[linux-2.6.git] / include / linux / mmc / sdio_func.h
1 /*
2  *  include/linux/mmc/sdio_func.h
3  *
4  *  Copyright 2007-2008 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 #include <linux/mmc/pm.h>
19
20 struct mmc_card;
21 struct sdio_func;
22
23 typedef void (sdio_irq_handler_t)(struct sdio_func *);
24
25 /*
26  * SDIO function CIS tuple (unknown to the core)
27  */
28 struct sdio_func_tuple {
29         struct sdio_func_tuple *next;
30         unsigned char code;
31         unsigned char size;
32         unsigned char data[0];
33 };
34
35 /*
36  * SDIO function devices
37  */
38 struct sdio_func {
39         struct mmc_card         *card;          /* the card this device belongs to */
40         struct device           dev;            /* the device */
41         sdio_irq_handler_t      *irq_handler;   /* IRQ callback */
42         unsigned int            num;            /* function number */
43
44         unsigned char           class;          /* standard interface class */
45         unsigned short          vendor;         /* vendor id */
46         unsigned short          device;         /* device id */
47
48         unsigned                max_blksize;    /* maximum block size */
49         unsigned                cur_blksize;    /* current block size */
50
51         unsigned                enable_timeout; /* max enable timeout in msec */
52
53         unsigned int            state;          /* function state */
54 #define SDIO_STATE_PRESENT      (1<<0)          /* present in sysfs */
55
56         u8                      tmpbuf[4];      /* DMA:able scratch buffer */
57
58         unsigned                num_info;       /* number of info strings */
59         const char              **info;         /* info strings */
60
61         struct sdio_func_tuple *tuples;
62 };
63
64 #define sdio_func_present(f)    ((f)->state & SDIO_STATE_PRESENT)
65
66 #define sdio_func_set_present(f) ((f)->state |= SDIO_STATE_PRESENT)
67
68 #define sdio_func_id(f)         (dev_name(&(f)->dev))
69
70 #define sdio_get_drvdata(f)     dev_get_drvdata(&(f)->dev)
71 #define sdio_set_drvdata(f,d)   dev_set_drvdata(&(f)->dev, d)
72 #define dev_to_sdio_func(d)     container_of(d, struct sdio_func, dev)
73
74 /*
75  * SDIO function device driver
76  */
77 struct sdio_driver {
78         char *name;
79         const struct sdio_device_id *id_table;
80
81         int (*probe)(struct sdio_func *, const struct sdio_device_id *);
82         void (*remove)(struct sdio_func *);
83
84         struct device_driver drv;
85 };
86
87 #define to_sdio_driver(d)       container_of(d, struct sdio_driver, drv)
88
89 /**
90  * SDIO_DEVICE - macro used to describe a specific SDIO device
91  * @vend: the 16 bit manufacturer code
92  * @dev: the 16 bit function id
93  *
94  * This macro is used to create a struct sdio_device_id that matches a
95  * specific device. The class field will be set to SDIO_ANY_ID.
96  */
97 #define SDIO_DEVICE(vend,dev) \
98         .class = SDIO_ANY_ID, \
99         .vendor = (vend), .device = (dev)
100
101 /**
102  * SDIO_DEVICE_CLASS - macro used to describe a specific SDIO device class
103  * @dev_class: the 8 bit standard interface code
104  *
105  * This macro is used to create a struct sdio_device_id that matches a
106  * specific standard SDIO function type.  The vendor and device fields will
107  * be set to SDIO_ANY_ID.
108  */
109 #define SDIO_DEVICE_CLASS(dev_class) \
110         .class = (dev_class), \
111         .vendor = SDIO_ANY_ID, .device = SDIO_ANY_ID
112
113 extern int sdio_register_driver(struct sdio_driver *);
114 extern void sdio_unregister_driver(struct sdio_driver *);
115
116 /*
117  * SDIO I/O operations
118  */
119 extern void sdio_claim_host(struct sdio_func *func);
120 extern void sdio_release_host(struct sdio_func *func);
121
122 extern int sdio_enable_func(struct sdio_func *func);
123 extern int sdio_disable_func(struct sdio_func *func);
124
125 extern int sdio_set_block_size(struct sdio_func *func, unsigned blksz);
126
127 extern int sdio_claim_irq(struct sdio_func *func, sdio_irq_handler_t *handler);
128 extern int sdio_release_irq(struct sdio_func *func);
129
130 extern unsigned int sdio_align_size(struct sdio_func *func, unsigned int sz);
131
132 extern u8 sdio_readb(struct sdio_func *func, unsigned int addr, int *err_ret);
133 extern u16 sdio_readw(struct sdio_func *func, unsigned int addr, int *err_ret);
134 extern u32 sdio_readl(struct sdio_func *func, unsigned int addr, int *err_ret);
135
136 extern int sdio_memcpy_fromio(struct sdio_func *func, void *dst,
137         unsigned int addr, int count);
138 extern int sdio_readsb(struct sdio_func *func, void *dst,
139         unsigned int addr, int count);
140
141 extern void sdio_writeb(struct sdio_func *func, u8 b,
142         unsigned int addr, int *err_ret);
143 extern void sdio_writew(struct sdio_func *func, u16 b,
144         unsigned int addr, int *err_ret);
145 extern void sdio_writel(struct sdio_func *func, u32 b,
146         unsigned int addr, int *err_ret);
147
148 extern u8 sdio_writeb_readb(struct sdio_func *func, u8 write_byte,
149         unsigned int addr, int *err_ret);
150
151 extern int sdio_memcpy_toio(struct sdio_func *func, unsigned int addr,
152         void *src, int count);
153 extern int sdio_writesb(struct sdio_func *func, unsigned int addr,
154         void *src, int count);
155
156 extern unsigned char sdio_f0_readb(struct sdio_func *func,
157         unsigned int addr, int *err_ret);
158 extern void sdio_f0_writeb(struct sdio_func *func, unsigned char b,
159         unsigned int addr, int *err_ret);
160
161 extern mmc_pm_flag_t sdio_get_host_pm_caps(struct sdio_func *func);
162 extern int sdio_set_host_pm_flags(struct sdio_func *func, mmc_pm_flag_t flags);
163
164 #endif
165