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