drivers/pcmcia/cs_internal.h

   1 /*
   2  * cs_internal.h -- definitions internal to the PCMCIA core modules
   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  * The initial developer of the original code is David A. Hinds
   9  * <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
  10  * are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
  11  *
  12  * (C) 1999             David A. Hinds
  13  * (C) 2003 - 2010      Dominik Brodowski
  14  *
  15  *
  16  * This file contains definitions _only_ needed by the PCMCIA core modules.
  17  * It must not be included by PCMCIA socket drivers or by PCMCIA device
  18  * drivers.
  19  */
  20
  21 #ifndef _LINUX_CS_INTERNAL_H
  22 #define _LINUX_CS_INTERNAL_H
  23
  24 #include <linux/kref.h>
  25
  26 /* Flags in client state */
  27 #define CLIENT_WIN_REQ(i)       (0x1<<(i))
  28
  29 /* Each card function gets one of these guys */
  30 typedef struct config_t {
  31         struct kref     ref;
  32         unsigned int    state;
  33         unsigned int    Attributes;
  34         unsigned int    IntType;
  35         unsigned int    ConfigBase;
  36         unsigned char   Status, Pin, Copy, Option, ExtStatus;
  37         unsigned int    CardValues;
  38         io_req_t        io;
  39         struct {
  40                 u_int   Attributes;
  41         } irq;
  42 } config_t;
  43
  44
  45 struct cis_cache_entry {
  46         struct list_head        node;
  47         unsigned int            addr;
  48         unsigned int            len;
  49         unsigned int            attr;
  50         unsigned char           cache[0];
  51 };
  52
  53 struct pccard_resource_ops {
  54         int     (*validate_mem)         (struct pcmcia_socket *s);
  55         int     (*find_io)              (struct pcmcia_socket *s,
  56                                          unsigned int attr,
  57                                          unsigned int *base,
  58                                          unsigned int num,
  59                                          unsigned int align);
  60         struct resource* (*find_mem)    (unsigned long base, unsigned long num,
  61                                          unsigned long align, int low,
  62                                          struct pcmcia_socket *s);
  63         int     (*init)                 (struct pcmcia_socket *s);
  64         void    (*exit)                 (struct pcmcia_socket *s);
  65 };
  66
  67 /* Flags in config state */
  68 #define CONFIG_LOCKED           0x01
  69 #define CONFIG_IRQ_REQ          0x02
  70 #define CONFIG_IO_REQ           0x04
  71
  72 /* Flags in socket state */
  73 #define SOCKET_PRESENT          0x0008
  74 #define SOCKET_INUSE            0x0010
  75 #define SOCKET_SUSPEND          0x0080
  76 #define SOCKET_WIN_REQ(i)       (0x0100<<(i))
  77 #define SOCKET_CARDBUS          0x8000
  78 #define SOCKET_CARDBUS_CONFIG   0x10000
  79
  80
  81 /*
  82  * Stuff internal to module "pcmcia_rsrc":
  83  */
  84 extern int static_init(struct pcmcia_socket *s);
  85 extern struct resource *pcmcia_make_resource(unsigned long start,
  86                                         unsigned long end,
  87                                         int flags, const char *name);
  88
  89 /*
  90  * Stuff internal to module "pcmcia_core":
  91  */
  92
  93 /* socket_sysfs.c */
  94 extern int pccard_sysfs_add_socket(struct device *dev);
  95 extern void pccard_sysfs_remove_socket(struct device *dev);
  96
  97 /* cardbus.c */
  98 int cb_alloc(struct pcmcia_socket *s);
  99 void cb_free(struct pcmcia_socket *s);
 100
 101
 102
 103 /*
 104  * Stuff exported by module "pcmcia_core" to module "pcmcia"
 105  */
 106
 107 struct pcmcia_callback{
 108         struct module   *owner;
 109         int             (*add) (struct pcmcia_socket *s);
 110         int             (*remove) (struct pcmcia_socket *s);
 111         void            (*requery) (struct pcmcia_socket *s);
 112         int             (*validate) (struct pcmcia_socket *s, unsigned int *i);
 113         int             (*suspend) (struct pcmcia_socket *s);
 114         int             (*early_resume) (struct pcmcia_socket *s);
 115         int             (*resume) (struct pcmcia_socket *s);
 116 };
 117
 118 /* cs.c */
 119 extern struct rw_semaphore pcmcia_socket_list_rwsem;
 120 extern struct list_head pcmcia_socket_list;
 121 extern struct class pcmcia_socket_class;
 122
 123 int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c);
 124 struct pcmcia_socket *pcmcia_get_socket_by_nr(unsigned int nr);
 125
 126 void pcmcia_parse_uevents(struct pcmcia_socket *socket, unsigned int events);
 127 #define PCMCIA_UEVENT_EJECT     0x0001
 128 #define PCMCIA_UEVENT_INSERT    0x0002
 129 #define PCMCIA_UEVENT_SUSPEND   0x0004
 130 #define PCMCIA_UEVENT_RESUME    0x0008
 131 #define PCMCIA_UEVENT_REQUERY   0x0010
 132
 133 struct pcmcia_socket *pcmcia_get_socket(struct pcmcia_socket *skt);
 134 void pcmcia_put_socket(struct pcmcia_socket *skt);
 135
 136 /*
 137  * Stuff internal to module "pcmcia".
 138  */
 139 /* ds.c */
 140 extern struct bus_type pcmcia_bus_type;
 141
 142 struct pcmcia_device;
 143
 144 /* pcmcia_resource.c */
 145 extern int pcmcia_release_configuration(struct pcmcia_device *p_dev);
 146 extern int pcmcia_validate_mem(struct pcmcia_socket *s);
 147 extern struct resource *pcmcia_find_mem_region(u_long base,
 148                                                u_long num,
 149                                                u_long align,
 150                                                int low,
 151                                                struct pcmcia_socket *s);
 152
 153 void pcmcia_cleanup_irq(struct pcmcia_socket *s);
 154 int pcmcia_setup_irq(struct pcmcia_device *p_dev);
 155
 156 /* cistpl.c */
 157 extern struct bin_attribute pccard_cis_attr;
 158
 159 int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
 160                         u_int addr, u_int len, void *ptr);
 161 void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
 162                           u_int addr, u_int len, void *ptr);
 163 void release_cis_mem(struct pcmcia_socket *s);
 164 void destroy_cis_cache(struct pcmcia_socket *s);
 165 int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function,
 166                       cisdata_t code, void *parse);
 167 int pcmcia_replace_cis(struct pcmcia_socket *s,
 168                        const u8 *data, const size_t len);
 169 int pccard_validate_cis(struct pcmcia_socket *s, unsigned int *count);
 170 int verify_cis_cache(struct pcmcia_socket *s);
 171
 172 int pccard_loop_tuple(struct pcmcia_socket *s, unsigned int function,
 173                       cisdata_t code, cisparse_t *parse, void *priv_data,
 174                       int (*loop_tuple) (tuple_t *tuple,
 175                                          cisparse_t *parse,
 176                                          void *priv_data));
 177
 178 int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function,
 179                         tuple_t *tuple);
 180
 181 int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function,
 182                         tuple_t *tuple);
 183
 184 int pccard_get_tuple_data(struct pcmcia_socket *s, tuple_t *tuple);
 185
 186 #endif /* _LINUX_CS_INTERNAL_H */