/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * cs_internal.h -- definitions internal to the PCMCIA core modules
 *
 * The initial developer of the original code is David A. Hinds
 * <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
 * are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
 *
 * (C) 1999             David A. Hinds
 * (C) 2003 - 2010      Dominik Brodowski
 *
 * This file contains definitions _only_ needed by the PCMCIA core modules.
 * It must not be included by PCMCIA socket drivers or by PCMCIA device
 * drivers.
 */

#ifndef _LINUX_CS_INTERNAL_H
#define _LINUX_CS_INTERNAL_H

#include <linux/kref.h>

/* Flags in client state */
#define CLIENT_WIN_REQ(i)       (0x1<<(i))

/* Flag to access all functions */
#define BIND_FN_ALL     0xff

/* Each card function gets one of these guys */
typedef struct config_t {
        struct kref     ref;
        unsigned int    state;

        struct resource io[MAX_IO_WIN]; /* io ports */
        struct resource mem[MAX_WIN];   /* mem areas */
} config_t;


struct cis_cache_entry {
        struct list_head        node;
        unsigned int            addr;
        unsigned int            len;
        unsigned int            attr;
        unsigned char           cache[];
};

struct pccard_resource_ops {
        int     (*validate_mem)         (struct pcmcia_socket *s);
        int     (*find_io)              (struct pcmcia_socket *s,
                                         unsigned int attr,
                                         unsigned int *base,
                                         unsigned int num,
                                         unsigned int align,
                                         struct resource **parent);
        struct resource* (*find_mem)    (unsigned long base, unsigned long num,
                                         unsigned long align, int low,
                                         struct pcmcia_socket *s);
        int     (*init)                 (struct pcmcia_socket *s);
        void    (*exit)                 (struct pcmcia_socket *s);
};

/* Flags in config state */
#define CONFIG_LOCKED           0x01
#define CONFIG_IRQ_REQ          0x02
#define CONFIG_IO_REQ           0x04

/* Flags in socket state */
#define SOCKET_PRESENT          0x0008
#define SOCKET_INUSE            0x0010
#define SOCKET_IN_RESUME        0x0040
#define SOCKET_SUSPEND          0x0080
#define SOCKET_WIN_REQ(i)       (0x0100<<(i))
#define SOCKET_CARDBUS          0x8000
#define SOCKET_CARDBUS_CONFIG   0x10000


/*
 * Stuff internal to module "pcmcia_rsrc":
 */
extern int static_init(struct pcmcia_socket *s);
extern struct resource *pcmcia_make_resource(resource_size_t start,
                                        resource_size_t end,
                                        unsigned long flags, const char *name);

/*
 * Stuff internal to module "pcmcia_core":
 */

/* socket_sysfs.c */
extern int pccard_sysfs_add_socket(struct device *dev);
extern void pccard_sysfs_remove_socket(struct device *dev);

/* cardbus.c */
int cb_alloc(struct pcmcia_socket *s);
void cb_free(struct pcmcia_socket *s);



/*
 * Stuff exported by module "pcmcia_core" to module "pcmcia"
 */

struct pcmcia_callback{
        struct module   *owner;
        int             (*add) (struct pcmcia_socket *s);
        int             (*remove) (struct pcmcia_socket *s);
        void            (*requery) (struct pcmcia_socket *s);
        int             (*validate) (struct pcmcia_socket *s, unsigned int *i);
        int             (*suspend) (struct pcmcia_socket *s);
        int             (*early_resume) (struct pcmcia_socket *s);
        int             (*resume) (struct pcmcia_socket *s);
};

/* cs.c */
extern struct rw_semaphore pcmcia_socket_list_rwsem;
extern struct list_head pcmcia_socket_list;
extern const struct class pcmcia_socket_class;

int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c);

void pcmcia_parse_uevents(struct pcmcia_socket *socket, unsigned int events);
#define PCMCIA_UEVENT_EJECT     0x0001
#define PCMCIA_UEVENT_INSERT    0x0002
#define PCMCIA_UEVENT_SUSPEND   0x0004
#define PCMCIA_UEVENT_RESUME    0x0008
#define PCMCIA_UEVENT_REQUERY   0x0010

struct pcmcia_socket *pcmcia_get_socket(struct pcmcia_socket *skt);
void pcmcia_put_socket(struct pcmcia_socket *skt);

/*
 * Stuff internal to module "pcmcia".
 */
/* ds.c */
extern const struct bus_type pcmcia_bus_type;

struct pcmcia_device;

/* pcmcia_resource.c */
extern int pcmcia_release_configuration(struct pcmcia_device *p_dev);
extern int pcmcia_validate_mem(struct pcmcia_socket *s);
extern struct resource *pcmcia_find_mem_region(u_long base,
                                               u_long num,
                                               u_long align,
                                               int low,
                                               struct pcmcia_socket *s);

void pcmcia_cleanup_irq(struct pcmcia_socket *s);
int pcmcia_setup_irq(struct pcmcia_device *p_dev);

/* cistpl.c */
extern const struct bin_attribute pccard_cis_attr;

int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
                        u_int addr, u_int len, void *ptr);
int pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
                        u_int addr, u_int len, void *ptr);
void release_cis_mem(struct pcmcia_socket *s);
void destroy_cis_cache(struct pcmcia_socket *s);
int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function,
                      cisdata_t code, void *parse);
int pcmcia_replace_cis(struct pcmcia_socket *s,
                       const u8 *data, const size_t len);
int pccard_validate_cis(struct pcmcia_socket *s, unsigned int *count);
int verify_cis_cache(struct pcmcia_socket *s);

int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function,
                        tuple_t *tuple);

int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function,
                        tuple_t *tuple);

int pccard_get_tuple_data(struct pcmcia_socket *s, tuple_t *tuple);

#endif /* _LINUX_CS_INTERNAL_H */