ipack.h

Go to the documentation of this file.

/*
 * Industry-pack bus.
 *
 * (C) 2011 Samuel Iglesias Gonsalvez <[email protected]>, CERN
 * (C) 2012 Samuel Iglesias Gonsalvez <[email protected]>, Igalia
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; version 2 of the License.
 */

#include <linux/mod_devicetable.h>
#include <linux/device.h>
#include <linux/interrupt.h>

#include "ipack_ids.h"

#define IPACK_IDPROM_OFFSET_I           0x01
#define IPACK_IDPROM_OFFSET_P           0x03
#define IPACK_IDPROM_OFFSET_A           0x05
#define IPACK_IDPROM_OFFSET_C           0x07
#define IPACK_IDPROM_OFFSET_MANUFACTURER_ID 0x09
#define IPACK_IDPROM_OFFSET_MODEL       0x0B
#define IPACK_IDPROM_OFFSET_REVISION        0x0D
#define IPACK_IDPROM_OFFSET_RESERVED        0x0F
#define IPACK_IDPROM_OFFSET_DRIVER_ID_L     0x11
#define IPACK_IDPROM_OFFSET_DRIVER_ID_H     0x13
#define IPACK_IDPROM_OFFSET_NUM_BYTES       0x15
#define IPACK_IDPROM_OFFSET_CRC         0x17

struct ipack_bus_ops;
struct ipack_driver;

enum ipack_space {
    IPACK_IO_SPACE    = 0,
    IPACK_ID_SPACE    = 1,
    IPACK_MEM_SPACE   = 2,
    IPACK_INT_SPACE,
};

struct ipack_addr_space {
    void __iomem *address;
    unsigned int size;
};

struct ipack_device {
    unsigned int bus_nr;
    unsigned int slot;
    struct ipack_bus_device *bus;
    struct ipack_addr_space id_space;
    struct ipack_addr_space io_space;
    struct ipack_addr_space int_space;
    struct ipack_addr_space mem_space;
    struct device dev;
    u8                      *id;
    size_t           id_avail;
    u32          id_vendor;
    u32          id_device;
    u8           id_format;
    unsigned int         id_crc_correct:1;
    unsigned int         speed_8mhz:1;
    unsigned int         speed_32mhz:1;
};

struct ipack_driver_ops {
    int (*probe) (struct ipack_device *dev);
    void (*remove) (struct ipack_device *dev);
};

struct ipack_driver {
    struct device_driver driver;
    const struct ipack_device_id *id_table;
    const struct ipack_driver_ops *ops;
};

struct ipack_bus_ops {
    int (*map_space) (struct ipack_device *dev, unsigned int memory_size, int space);
    int (*unmap_space) (struct ipack_device *dev, int space);
    int (*request_irq) (struct ipack_device *dev,
                irqreturn_t (*handler)(void *), void *arg);
    int (*free_irq) (struct ipack_device *dev);
    int (*get_clockrate) (struct ipack_device *dev);
    int (*set_clockrate) (struct ipack_device *dev, int mherz);
    int (*get_error) (struct ipack_device *dev);
    int (*get_timeout) (struct ipack_device *dev);
    int (*reset_timeout) (struct ipack_device *dev);
};

struct ipack_bus_device {
    struct device *parent;
    int slots;
    int bus_nr;
    const struct ipack_bus_ops *ops;
};

struct ipack_bus_device *ipack_bus_register(struct device *parent, int slots,
                        const struct ipack_bus_ops *ops);

int ipack_bus_unregister(struct ipack_bus_device *bus);

int ipack_driver_register(struct ipack_driver *edrv, struct module *owner,
              const char *name);
void ipack_driver_unregister(struct ipack_driver *edrv);

struct ipack_device *ipack_device_register(struct ipack_bus_device *bus, int slot);
void ipack_device_unregister(struct ipack_device *dev);

#define DEFINE_IPACK_DEVICE_TABLE(_table) \
    const struct ipack_device_id _table[] __devinitconst

#define IPACK_DEVICE(_format, vend, dev) \
     .format = (_format), \
     .vendor = (vend), \
     .device = (dev)