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         u8                      tmpbuf[4];      /* DMA:able scratch buffer */
  52
  53         struct sdio_func_tuple *tuples;
  54 };
  55
  56 #define sdio_func_present(f)    ((f)->state & SDIO_STATE_PRESENT)
  57
  58 #define sdio_func_set_present(f) ((f)->state |= SDIO_STATE_PRESENT)
  59
  60 #define sdio_func_id(f)         ((f)->dev.bus_id)
  61
  62 #define sdio_get_drvdata(f)     dev_get_drvdata(&(f)->dev)
  63 #define sdio_set_drvdata(f,d)   dev_set_drvdata(&(f)->dev, d)
  64
  65 /*
  66  * SDIO function device driver
  67  */
  68 struct sdio_driver {
  69         char *name;
  70         const struct sdio_device_id *id_table;
  71
  72         int (*probe)(struct sdio_func *, const struct sdio_device_id *);
  73         void (*remove)(struct sdio_func *);
  74
  75         struct device_driver drv;
  76 };
  77
  78 /**
  79  * SDIO_DEVICE - macro used to describe a specific SDIO device
  80  * @vend: the 16 bit manufacturer code
  81  * @dev: the 16 bit function id
  82  *
  83  * This macro is used to create a struct sdio_device_id that matches a
  84  * specific device. The class field will be set to SDIO_ANY_ID.
  85  */
  86 #define SDIO_DEVICE(vend,dev) \
  87         .class = SDIO_ANY_ID, \
  88         .vendor = (vend), .device = (dev)
  89
  90 /**
  91  * SDIO_DEVICE_CLASS - macro used to describe a specific SDIO device class
  92  * @dev_class: the 8 bit standard interface code
  93  *
  94  * This macro is used to create a struct sdio_device_id that matches a
  95  * specific standard SDIO function type.  The vendor and device fields will
  96  * be set to SDIO_ANY_ID.
  97  */
  98 #define SDIO_DEVICE_CLASS(dev_class) \
  99         .class = (dev_class), \
 100         .vendor = SDIO_ANY_ID, .device = SDIO_ANY_ID
 101
 102 extern int sdio_register_driver(struct sdio_driver *);
 103 extern void sdio_unregister_driver(struct sdio_driver *);
 104
 105 /*
 106  * SDIO I/O operations
 107  */
 108 extern void sdio_claim_host(struct sdio_func *func);
 109 extern void sdio_release_host(struct sdio_func *func);
 110
 111 extern int sdio_enable_func(struct sdio_func *func);
 112 extern int sdio_disable_func(struct sdio_func *func);
 113
 114 extern int sdio_claim_irq(struct sdio_func *func, sdio_irq_handler_t *handler);
 115 extern int sdio_release_irq(struct sdio_func *func);
 116
 117 extern unsigned char sdio_readb(struct sdio_func *func,
 118         unsigned int addr, int *err_ret);
 119 extern unsigned short sdio_readw(struct sdio_func *func,
 120         unsigned int addr, int *err_ret);
 121 extern unsigned long sdio_readl(struct sdio_func *func,
 122         unsigned int addr, int *err_ret);
 123
 124 extern int sdio_memcpy_fromio(struct sdio_func *func, void *dst,
 125         unsigned int addr, int count);
 126 extern int sdio_readsb(struct sdio_func *func, void *dst,
 127         unsigned int addr, int count);
 128
 129 extern void sdio_writeb(struct sdio_func *func, unsigned char b,
 130         unsigned int addr, int *err_ret);
 131 extern void sdio_writew(struct sdio_func *func, unsigned short b,
 132         unsigned int addr, int *err_ret);
 133 extern void sdio_writel(struct sdio_func *func, unsigned long b,
 134         unsigned int addr, int *err_ret);
 135
 136 extern int sdio_memcpy_toio(struct sdio_func *func, unsigned int addr,
 137         void *src, int count);
 138 extern int sdio_writesb(struct sdio_func *func, unsigned int addr,
 139         void *src, int count);
 140
 141 #endif
 142