include/linux/mmc/core.h

   1 /*
   2  *  linux/include/linux/mmc/core.h
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  */
   8 #ifndef LINUX_MMC_CORE_H
   9 #define LINUX_MMC_CORE_H
  10
  11 #include <linux/interrupt.h>
  12 #include <linux/device.h>
  13
  14 struct request;
  15 struct mmc_data;
  16 struct mmc_request;
  17
  18 struct mmc_command {
  19         u32                     opcode;
  20         u32                     arg;
  21         u32                     resp[4];
  22         unsigned int            flags;          /* expected response type */
  23 #define MMC_RSP_PRESENT (1 << 0)
  24 #define MMC_RSP_136     (1 << 1)                /* 136 bit response */
  25 #define MMC_RSP_CRC     (1 << 2)                /* expect valid crc */
  26 #define MMC_RSP_BUSY    (1 << 3)                /* card may send busy */
  27 #define MMC_RSP_OPCODE  (1 << 4)                /* response contains opcode */
  28 #define MMC_CMD_MASK    (3 << 5)                /* command type */
  29 #define MMC_CMD_AC      (0 << 5)
  30 #define MMC_CMD_ADTC    (1 << 5)
  31 #define MMC_CMD_BC      (2 << 5)
  32 #define MMC_CMD_BCR     (3 << 5)
  33
  34 /*
  35  * These are the response types, and correspond to valid bit
  36  * patterns of the above flags.  One additional valid pattern
  37  * is all zeros, which means we don't expect a response.
  38  */
  39 #define MMC_RSP_NONE    (0)
  40 #define MMC_RSP_R1      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
  41 #define MMC_RSP_R1B     (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE|MMC_RSP_BUSY)
  42 #define MMC_RSP_R2      (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
  43 #define MMC_RSP_R3      (MMC_RSP_PRESENT)
  44 #define MMC_RSP_R6      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
  45 #define MMC_RSP_R7      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
  46
  47 #define mmc_resp_type(cmd)      ((cmd)->flags & (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC|MMC_RSP_BUSY|MMC_RSP_OPCODE))
  48
  49 /*
  50  * These are the command types.
  51  */
  52 #define mmc_cmd_type(cmd)       ((cmd)->flags & MMC_CMD_MASK)
  53
  54         unsigned int            retries;        /* max number of retries */
  55         unsigned int            error;          /* command error */
  56
  57 /*
  58  * Standard errno values are used for errors, but some have specific
  59  * meaning in the MMC layer:
  60  *
  61  * ETIMEDOUT    Card took too long to respond
  62  * EILSEQ       Basic format problem with the received or sent data
  63  *              (e.g. CRC check failed, incorrect opcode in response
  64  *              or bad end bit)
  65  * EINVAL       Request cannot be performed because of restrictions
  66  *              in hardware and/or the driver
  67  * ENOMEDIUM    Host can determine that the slot is empty and is
  68  *              actively failing requests
  69  */
  70
  71         struct mmc_data         *data;          /* data segment associated with cmd */
  72         struct mmc_request      *mrq;           /* associated request */
  73 };
  74
  75 struct mmc_data {
  76         unsigned int            timeout_ns;     /* data timeout (in ns, max 80ms) */
  77         unsigned int            timeout_clks;   /* data timeout (in clocks) */
  78         unsigned int            blksz;          /* data block size */
  79         unsigned int            blocks;         /* number of blocks */
  80         unsigned int            error;          /* data error */
  81         unsigned int            flags;
  82
  83 #define MMC_DATA_WRITE  (1 << 8)
  84 #define MMC_DATA_READ   (1 << 9)
  85 #define MMC_DATA_STREAM (1 << 10)
  86 #define MMC_DATA_MULTI  (1 << 11)
  87
  88         unsigned int            bytes_xfered;
  89
  90         struct mmc_command      *stop;          /* stop command */
  91         struct mmc_request      *mrq;           /* associated request */
  92
  93         unsigned int            sg_len;         /* size of scatter list */
  94         struct scatterlist      *sg;            /* I/O scatter list */
  95 };
  96
  97 struct mmc_request {
  98         struct mmc_command      *cmd;
  99         struct mmc_data         *data;
 100         struct mmc_command      *stop;
 101
 102         void                    *done_data;     /* completion data */
 103         void                    (*done)(struct mmc_request *);/* completion function */
 104 };
 105
 106 struct mmc_host;
 107 struct mmc_card;
 108
 109 extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *);
 110 extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int);
 111 extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *,
 112         struct mmc_command *, int);
 113
 114 extern void mmc_set_data_timeout(struct mmc_data *, const struct mmc_card *);
 115
 116 extern void mmc_claim_host(struct mmc_host *host);
 117 extern void mmc_release_host(struct mmc_host *host);
 118
 119 #endif