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 struct mmc_card;
  19 struct sdio_func;
  20
  21 typedef void (sdio_irq_handler_t)(struct sdio_func *);
  22
  23 /*
  24  * Structure used to hold embedded SDIO device data from platform layer
  25  */
  26 struct sdio_embedded_func {
  27         uint8_t f_class;
  28         uint32_t f_maxblksize;
  29 };
  30
  31 /*
  32  * SDIO function CIS tuple (unknown to the core)
  33  */
  34 struct sdio_func_tuple {
  35         struct sdio_func_tuple *next;
  36         unsigned char code;
  37         unsigned char size;
  38         unsigned char data[0];
  39 };
  40
  41 /*
  42  * SDIO function devices
  43  */
  44 struct sdio_func {
  45         struct mmc_card         *card;          /* the card this device belongs to */
  46         struct device           dev;            /* the device */
  47         sdio_irq_handler_t      *irq_handler;   /* IRQ callback */
  48         unsigned int            num;            /* function number */
  49
  50         unsigned char           class;          /* standard interface class */
  51         unsigned short          vendor;         /* vendor id */
  52         unsigned short          device;         /* device id */
  53
  54         unsigned                max_blksize;    /* maximum block size */
  55         unsigned                cur_blksize;    /* current block size */
  56
  57         unsigned                enable_timeout; /* max enable timeout in msec */
  58
  59         unsigned int            state;          /* function state */
  60 #define SDIO_STATE_PRESENT      (1<<0)          /* present in sysfs */
  61
  62         u8                      tmpbuf[4];      /* DMA:able scratch buffer */
  63
  64         unsigned                num_info;       /* number of info strings */
  65         const char              **info;         /* info strings */
  66
  67         struct sdio_func_tuple *tuples;
  68 };
  69
  70 #define sdio_func_present(f)    ((f)->state & SDIO_STATE_PRESENT)
  71
  72 #define sdio_func_set_present(f) ((f)->state |= SDIO_STATE_PRESENT)
  73
  74 #define sdio_func_id(f)         (dev_name(&(f)->dev))
  75
  76 #define sdio_get_drvdata(f)     dev_get_drvdata(&(f)->dev)
  77 #define sdio_set_drvdata(f,d)   dev_set_drvdata(&(f)->dev, d)
  78 #define dev_to_sdio_func(d)     container_of(d, struct sdio_func, dev)
  79
  80 /*
  81  * SDIO function device driver
  82  */
  83 struct sdio_driver {
  84         char *name;
  85         const struct sdio_device_id *id_table;
  86
  87         int (*probe)(struct sdio_func *, const struct sdio_device_id *);
  88         void (*remove)(struct sdio_func *);
  89
  90         struct device_driver drv;
  91 };
  92
  93 #define to_sdio_driver(d)       container_of(d, struct sdio_driver, drv)
  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 int sdio_memcpy_toio(struct sdio_func *func, unsigned int addr,
 155         void *src, int count);
 156 extern int sdio_writesb(struct sdio_func *func, unsigned int addr,
 157         void *src, int count);
 158
 159 extern unsigned char sdio_f0_readb(struct sdio_func *func,
 160         unsigned int addr, int *err_ret);
 161 extern void sdio_f0_writeb(struct sdio_func *func, unsigned char b,
 162         unsigned int addr, int *err_ret);
 163
 164 #endif
 165