tifm_sd: replace command completion state machine with full checking
[safe/jmp/linux-2.6] / include / linux / tifm.h
1 /*
2  *  tifm.h - TI FlashMedia driver
3  *
4  *  Copyright (C) 2006 Alex Dubov <oakad@yahoo.com>
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 version 2 as
8  * published by the Free Software Foundation.
9  *
10  */
11
12 #ifndef _TIFM_H
13 #define _TIFM_H
14
15 #include <linux/spinlock.h>
16 #include <linux/interrupt.h>
17 #include <linux/wait.h>
18 #include <linux/delay.h>
19 #include <linux/pci.h>
20 #include <linux/kthread.h>
21
22 /* Host registers (relative to pci base address): */
23 enum {
24         FM_SET_INTERRUPT_ENABLE   = 0x008,
25         FM_CLEAR_INTERRUPT_ENABLE = 0x00c,
26         FM_INTERRUPT_STATUS       = 0x014 };
27
28 /* Socket registers (relative to socket base address): */
29 enum {
30         SOCK_CONTROL                   = 0x004,
31         SOCK_PRESENT_STATE             = 0x008,
32         SOCK_DMA_ADDRESS               = 0x00c,
33         SOCK_DMA_CONTROL               = 0x010,
34         SOCK_DMA_FIFO_INT_ENABLE_SET   = 0x014,
35         SOCK_DMA_FIFO_INT_ENABLE_CLEAR = 0x018,
36         SOCK_DMA_FIFO_STATUS           = 0x020,
37         SOCK_FIFO_CONTROL              = 0x024,
38         SOCK_FIFO_PAGE_SIZE            = 0x028,
39         SOCK_MMCSD_COMMAND             = 0x104,
40         SOCK_MMCSD_ARG_LOW             = 0x108,
41         SOCK_MMCSD_ARG_HIGH            = 0x10c,
42         SOCK_MMCSD_CONFIG              = 0x110,
43         SOCK_MMCSD_STATUS              = 0x114,
44         SOCK_MMCSD_INT_ENABLE          = 0x118,
45         SOCK_MMCSD_COMMAND_TO          = 0x11c,
46         SOCK_MMCSD_DATA_TO             = 0x120,
47         SOCK_MMCSD_DATA                = 0x124,
48         SOCK_MMCSD_BLOCK_LEN           = 0x128,
49         SOCK_MMCSD_NUM_BLOCKS          = 0x12c,
50         SOCK_MMCSD_BUFFER_CONFIG       = 0x130,
51         SOCK_MMCSD_SPI_CONFIG          = 0x134,
52         SOCK_MMCSD_SDIO_MODE_CONFIG    = 0x138,
53         SOCK_MMCSD_RESPONSE            = 0x144,
54         SOCK_MMCSD_SDIO_SR             = 0x164,
55         SOCK_MMCSD_SYSTEM_CONTROL      = 0x168,
56         SOCK_MMCSD_SYSTEM_STATUS       = 0x16c,
57         SOCK_MS_COMMAND                = 0x184,
58         SOCK_MS_DATA                   = 0x188,
59         SOCK_MS_STATUS                 = 0x18c,
60         SOCK_MS_SYSTEM                 = 0x190,
61         SOCK_FIFO_ACCESS               = 0x200 };
62
63 #define TIFM_CTRL_LED             0x00000040
64 #define TIFM_CTRL_FAST_CLK        0x00000100
65
66 #define TIFM_SOCK_STATE_OCCUPIED  0x00000008
67 #define TIFM_SOCK_STATE_POWERED   0x00000080
68
69 #define TIFM_FIFO_ENABLE          0x00000001 /* Meaning of this constant is unverified */
70 #define TIFM_FIFO_READY           0x00000001 /* Meaning of this constant is unverified */
71 #define TIFM_FIFO_INT_SETALL      0x0000ffff
72 #define TIFM_FIFO_INTMASK         0x00000005 /* Meaning of this constant is unverified */
73
74 #define TIFM_DMA_RESET            0x00000002 /* Meaning of this constant is unverified */
75 #define TIFM_DMA_TX               0x00008000 /* Meaning of this constant is unverified */
76 #define TIFM_DMA_EN               0x00000001 /* Meaning of this constant is unverified */
77
78 #define TIFM_TYPE_XD 1
79 #define TIFM_TYPE_MS 2
80 #define TIFM_TYPE_SD 3
81
82 struct tifm_device_id {
83         unsigned char type;
84 };
85
86 struct tifm_driver;
87 struct tifm_dev {
88         char __iomem            *addr;
89         spinlock_t              lock;
90         unsigned char           type;
91         unsigned int            socket_id;
92
93         void          (*card_event)(struct tifm_dev *sock);
94         void          (*data_event)(struct tifm_dev *sock);
95
96         struct device           dev;
97 };
98
99 struct tifm_driver {
100         struct tifm_device_id *id_table;
101         int                  (*probe)(struct tifm_dev *dev);
102         void                 (*remove)(struct tifm_dev *dev);
103         int                  (*suspend)(struct tifm_dev *dev,
104                                         pm_message_t state);
105         int                  (*resume)(struct tifm_dev *dev);
106
107         struct device_driver driver;
108 };
109
110 struct tifm_adapter {
111         char __iomem            *addr;
112         spinlock_t              lock;
113         unsigned int            irq_status;
114         unsigned int            socket_change_set;
115         unsigned int            id;
116         unsigned int            num_sockets;
117         struct completion       *finish_me;
118
119         struct work_struct      media_switcher;
120         struct class_device     cdev;
121
122         void                    (*eject)(struct tifm_adapter *fm,
123                                          struct tifm_dev *sock);
124
125         struct tifm_dev         *sockets[0];
126 };
127
128 struct tifm_adapter *tifm_alloc_adapter(unsigned int num_sockets,
129                                         struct device *dev);
130 int tifm_add_adapter(struct tifm_adapter *fm);
131 void tifm_remove_adapter(struct tifm_adapter *fm);
132 void tifm_free_adapter(struct tifm_adapter *fm);
133
134 void tifm_free_device(struct device *dev);
135 struct tifm_dev *tifm_alloc_device(struct tifm_adapter *fm, unsigned int id,
136                                    unsigned char type);
137
138 int tifm_register_driver(struct tifm_driver *drv);
139 void tifm_unregister_driver(struct tifm_driver *drv);
140 void tifm_eject(struct tifm_dev *sock);
141 int tifm_map_sg(struct tifm_dev *sock, struct scatterlist *sg, int nents,
142                 int direction);
143 void tifm_unmap_sg(struct tifm_dev *sock, struct scatterlist *sg, int nents,
144                    int direction);
145 void tifm_queue_work(struct work_struct *work);
146
147 static inline void *tifm_get_drvdata(struct tifm_dev *dev)
148 {
149         return dev_get_drvdata(&dev->dev);
150 }
151
152 static inline void tifm_set_drvdata(struct tifm_dev *dev, void *data)
153 {
154         dev_set_drvdata(&dev->dev, data);
155 }
156
157 #endif