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
  20 /*
  21  * SDIO function CIS tuple (unknown to the core)
  22  */
  23 struct sdio_func_tuple {
  24         struct sdio_func_tuple *next;
  25         unsigned char code;
  26         unsigned char size;
  27         unsigned char data[0];
  28 };
  29
  30 /*
  31  * SDIO function devices
  32  */
  33 struct sdio_func {
  34         struct mmc_card         *card;          /* the card this device belongs to */
  35         struct device           dev;            /* the device */
  36         unsigned int            num;            /* function number */
  37
  38         unsigned char           class;          /* standard interface class */
  39         unsigned short          vendor;         /* vendor id */
  40         unsigned short          device;         /* device id */
  41
  42         unsigned short          blksize;        /* maximum block size */
  43
  44         unsigned int            state;          /* function state */
  45 #define SDIO_STATE_PRESENT      (1<<0)          /* present in sysfs */
  46
  47         struct sdio_func_tuple *tuples;
  48 };
  49
  50 #define sdio_func_present(f)    ((f)->state & SDIO_STATE_PRESENT)
  51
  52 #define sdio_func_set_present(f) ((f)->state |= SDIO_STATE_PRESENT)
  53
  54 #define sdio_func_id(f)         ((f)->dev.bus_id)
  55
  56 #define sdio_get_drvdata(f)     dev_get_drvdata(&(f)->dev)
  57 #define sdio_set_drvdata(f,d)   dev_set_drvdata(&(f)->dev, d)
  58
  59 /*
  60  * SDIO function device driver
  61  */
  62 struct sdio_driver {
  63         char *name;
  64         const struct sdio_device_id *id_table;
  65
  66         int (*probe)(struct sdio_func *, const struct sdio_device_id *);
  67         void (*remove)(struct sdio_func *);
  68
  69         struct device_driver drv;
  70 };
  71
  72 /**
  73  * SDIO_DEVICE - macro used to describe a specific SDIO device
  74  * @vend: the 16 bit manufacturer code
  75  * @dev: the 16 bit function id
  76  *
  77  * This macro is used to create a struct sdio_device_id that matches a
  78  * specific device. The class field will be set to SDIO_ANY_ID.
  79  */
  80 #define SDIO_DEVICE(vend,dev) \
  81         .class = SDIO_ANY_ID, \
  82         .vendor = (vend), .device = (dev)
  83
  84 /**
  85  * SDIO_DEVICE_CLASS - macro used to describe a specific SDIO device class
  86  * @dev_class: the 8 bit standard interface code
  87  *
  88  * This macro is used to create a struct sdio_device_id that matches a
  89  * specific standard SDIO function type.  The vendor and device fields will
  90  * be set to SDIO_ANY_ID.
  91  */
  92 #define SDIO_DEVICE_CLASS(dev_class) \
  93         .class = (dev_class), \
  94         .vendor = SDIO_ANY_ID, .device = SDIO_ANY_ID
  95
  96 extern int sdio_register_driver(struct sdio_driver *);
  97 extern void sdio_unregister_driver(struct sdio_driver *);
  98
  99 /*
 100  * SDIO I/O operations
 101  */
 102 extern void sdio_claim_host(struct sdio_func *func);
 103 extern void sdio_release_host(struct sdio_func *func);
 104
 105 extern int sdio_enable_func(struct sdio_func *func);
 106 extern int sdio_disable_func(struct sdio_func *func);
 107
 108 extern unsigned char sdio_readb(struct sdio_func *func,
 109         unsigned int addr, int *err_ret);
 110
 111 extern void sdio_writeb(struct sdio_func *func, unsigned char b,
 112         unsigned int addr, int *err_ret);
 113
 114 #endif
 115