LXR linux/include/linux/mmc/sdio

   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
  20struct mmc_card;
  21struct sdio_func;
  22
  23typedef void (sdio_irq_handler_t)(struct sdio_func *);
  24
  25/*
  26 * SDIO function CIS tuple (unknown to the core)
  27 */
  28struct 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 */
  38struct 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 */
  77struct 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/**
  88 * SDIO_DEVICE - macro used to describe a specific SDIO device
  89 * @vend: the 16 bit manufacturer code
  90 * @dev: the 16 bit function id
  91 *
  92 * This macro is used to create a struct sdio_device_id that matches a
  93 * specific device. The class field will be set to SDIO_ANY_ID.
  94 */
  95#define SDIO_DEVICE(vend,dev) \
  96        .class = SDIO_ANY_ID, \
  97        .vendor = (vend), .device = (dev)
  98
  99/**
 100 * SDIO_DEVICE_CLASS - macro used to describe a specific SDIO device class
 101 * @dev_class: the 8 bit standard interface code
 102 *
 103 * This macro is used to create a struct sdio_device_id that matches a
 104 * specific standard SDIO function type.  The vendor and device fields will
 105 * be set to SDIO_ANY_ID.
 106 */
 107#define SDIO_DEVICE_CLASS(dev_class) \
 108        .class = (dev_class), \
 109        .vendor = SDIO_ANY_ID, .device = SDIO_ANY_ID
 110
 111extern int sdio_register_driver(struct sdio_driver *);
 112extern void sdio_unregister_driver(struct sdio_driver *);
 113
 114/*
 115 * SDIO I/O operations
 116 */
 117extern void sdio_claim_host(struct sdio_func *func);
 118extern void sdio_release_host(struct sdio_func *func);
 119
 120extern int sdio_enable_func(struct sdio_func *func);
 121extern int sdio_disable_func(struct sdio_func *func);
 122
 123extern int sdio_set_block_size(struct sdio_func *func, unsigned blksz);
 124
 125extern int sdio_claim_irq(struct sdio_func *func, sdio_irq_handler_t *handler);
 126extern int sdio_release_irq(struct sdio_func *func);
 127
 128extern unsigned int sdio_align_size(struct sdio_func *func, unsigned int sz);
 129
 130extern u8 sdio_readb(struct sdio_func *func, unsigned int addr, int *err_ret);
 131extern u16 sdio_readw(struct sdio_func *func, unsigned int addr, int *err_ret);
 132extern u32 sdio_readl(struct sdio_func *func, unsigned int addr, int *err_ret);
 133
 134extern int sdio_memcpy_fromio(struct sdio_func *func, void *dst,
 135        unsigned int addr, int count);
 136extern int sdio_readsb(struct sdio_func *func, void *dst,
 137        unsigned int addr, int count);
 138
 139extern void sdio_writeb(struct sdio_func *func, u8 b,
 140        unsigned int addr, int *err_ret);
 141extern void sdio_writew(struct sdio_func *func, u16 b,
 142        unsigned int addr, int *err_ret);
 143extern void sdio_writel(struct sdio_func *func, u32 b,
 144        unsigned int addr, int *err_ret);
 145
 146extern u8 sdio_writeb_readb(struct sdio_func *func, u8 write_byte,
 147        unsigned int addr, int *err_ret);
 148
 149extern int sdio_memcpy_toio(struct sdio_func *func, unsigned int addr,
 150        void *src, int count);
 151extern int sdio_writesb(struct sdio_func *func, unsigned int addr,
 152        void *src, int count);
 153
 154extern unsigned char sdio_f0_readb(struct sdio_func *func,
 155        unsigned int addr, int *err_ret);
 156extern void sdio_f0_writeb(struct sdio_func *func, unsigned char b,
 157        unsigned int addr, int *err_ret);
 158
 159extern mmc_pm_flag_t sdio_get_host_pm_caps(struct sdio_func *func);
 160extern int sdio_set_host_pm_flags(struct sdio_func *func, mmc_pm_flag_t flags);
 161
 162#endif /* LINUX_MMC_SDIO_FUNC_H */
 163