2012-05-09 07:27:19 -06:00
|
|
|
/*
|
|
|
|
* Industry-pack bus.
|
|
|
|
*
|
|
|
|
* (C) 2011 Samuel Iglesias Gonsalvez <siglesia@cern.ch>, CERN
|
|
|
|
* (C) 2012 Samuel Iglesias Gonsalvez <siglesias@igalia.com>, 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
|
2012-05-11 02:17:13 -06:00
|
|
|
* Software Foundation; version 2 of the License.
|
2012-05-09 07:27:19 -06:00
|
|
|
*/
|
|
|
|
|
2012-09-04 09:01:13 -06:00
|
|
|
#include <linux/mod_devicetable.h>
|
2012-05-09 07:27:19 -06:00
|
|
|
#include <linux/device.h>
|
2012-09-12 06:55:38 -06:00
|
|
|
#include <linux/interrupt.h>
|
2012-05-09 07:27:19 -06:00
|
|
|
|
2012-09-04 09:01:14 -06:00
|
|
|
#include "ipack_ids.h"
|
|
|
|
|
2012-05-09 07:27:19 -06:00
|
|
|
#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,
|
2012-09-13 04:32:19 -06:00
|
|
|
IPACK_INT_SPACE,
|
2012-05-09 07:27:19 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* struct ipack_addr_space - Virtual address space mapped for a specified type.
|
|
|
|
*
|
|
|
|
* @address: virtual address
|
|
|
|
* @size: size of the mapped space
|
|
|
|
*/
|
|
|
|
struct ipack_addr_space {
|
2012-05-14 04:41:25 -06:00
|
|
|
void __iomem *address;
|
2012-05-09 07:27:19 -06:00
|
|
|
unsigned int size;
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* struct ipack_device
|
|
|
|
*
|
|
|
|
* @bus_nr: IP bus number where the device is plugged
|
|
|
|
* @slot: Slot where the device is plugged in the carrier board
|
2012-05-18 03:10:05 -06:00
|
|
|
* @bus: ipack_bus_device where the device is plugged to.
|
2012-05-09 07:27:19 -06:00
|
|
|
* @id_space: Virtual address to ID space.
|
|
|
|
* @io_space: Virtual address to IO space.
|
|
|
|
* @mem_space: Virtual address to MEM space.
|
|
|
|
* @dev: device in kernel representation.
|
|
|
|
*
|
|
|
|
* Warning: Direct access to mapped memory is possible but the endianness
|
|
|
|
* is not the same with PCI carrier or VME carrier. The endianness is managed
|
2012-05-18 03:10:05 -06:00
|
|
|
* by the carrier board throught bus->ops.
|
2012-05-09 07:27:19 -06:00
|
|
|
*/
|
|
|
|
struct ipack_device {
|
|
|
|
unsigned int bus_nr;
|
|
|
|
unsigned int slot;
|
2012-05-18 03:10:05 -06:00
|
|
|
struct ipack_bus_device *bus;
|
2012-05-09 07:27:19 -06:00
|
|
|
struct ipack_addr_space id_space;
|
|
|
|
struct ipack_addr_space io_space;
|
2012-09-13 04:32:19 -06:00
|
|
|
struct ipack_addr_space int_space;
|
2012-05-09 07:27:19 -06:00
|
|
|
struct ipack_addr_space mem_space;
|
|
|
|
struct device dev;
|
2012-09-04 09:01:15 -06:00
|
|
|
u8 *id;
|
2012-09-04 09:01:14 -06:00
|
|
|
size_t id_avail;
|
2012-09-04 09:01:15 -06:00
|
|
|
u32 id_vendor;
|
|
|
|
u32 id_device;
|
2012-09-04 09:01:14 -06:00
|
|
|
u8 id_format;
|
2012-09-11 05:35:03 -06:00
|
|
|
unsigned int id_crc_correct:1;
|
2012-09-11 05:34:57 -06:00
|
|
|
unsigned int speed_8mhz:1;
|
|
|
|
unsigned int speed_32mhz:1;
|
2012-05-09 07:27:19 -06:00
|
|
|
};
|
|
|
|
|
2012-05-18 03:10:05 -06:00
|
|
|
/**
|
2012-05-09 07:27:19 -06:00
|
|
|
* struct ipack_driver_ops -- callbacks to mezzanine driver for installing/removing one device
|
|
|
|
*
|
|
|
|
* @probe: Probe function
|
|
|
|
* @remove: tell the driver that the carrier board wants to remove one device
|
|
|
|
*/
|
|
|
|
|
|
|
|
struct ipack_driver_ops {
|
|
|
|
int (*probe) (struct ipack_device *dev);
|
|
|
|
void (*remove) (struct ipack_device *dev);
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2012-05-18 03:10:05 -06:00
|
|
|
* struct ipack_driver -- Specific data to each ipack board driver
|
2012-05-09 07:27:19 -06:00
|
|
|
*
|
|
|
|
* @driver: Device driver kernel representation
|
|
|
|
* @ops: Mezzanine driver operations specific for the ipack bus.
|
|
|
|
*/
|
|
|
|
struct ipack_driver {
|
|
|
|
struct device_driver driver;
|
2012-09-04 09:01:13 -06:00
|
|
|
const struct ipack_device_id *id_table;
|
2012-09-04 09:01:17 -06:00
|
|
|
const struct ipack_driver_ops *ops;
|
2012-05-09 07:27:19 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* struct ipack_bus_ops - available operations on a bridge module
|
|
|
|
*
|
|
|
|
* @map_space: map IP address space
|
|
|
|
* @unmap_space: unmap IP address space
|
|
|
|
* @request_irq: request IRQ
|
|
|
|
* @free_irq: free IRQ
|
2012-09-11 05:34:55 -06:00
|
|
|
* @get_clockrate: Returns the clockrate the carrier is currently
|
|
|
|
* communicating with the device at.
|
|
|
|
* @set_clockrate: Sets the clock-rate for carrier / module communication.
|
|
|
|
* Should return -EINVAL if the requested speed is not supported.
|
|
|
|
* @get_error: Returns the error state for the slot the device is attached
|
|
|
|
* to.
|
|
|
|
* @get_timeout: Returns 1 if the communication with the device has
|
|
|
|
* previously timed out.
|
|
|
|
* @reset_timeout: Resets the state returned by get_timeout.
|
2012-05-09 07:27:19 -06:00
|
|
|
*/
|
|
|
|
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);
|
2012-09-13 04:32:21 -06:00
|
|
|
int (*request_irq) (struct ipack_device *dev,
|
2012-09-12 06:55:38 -06:00
|
|
|
irqreturn_t (*handler)(void *), void *arg);
|
2012-05-09 07:27:19 -06:00
|
|
|
int (*free_irq) (struct ipack_device *dev);
|
2012-09-11 05:34:55 -06:00
|
|
|
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);
|
2012-05-09 07:27:19 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* struct ipack_bus_device
|
|
|
|
*
|
|
|
|
* @dev: pointer to carrier device
|
|
|
|
* @slots: number of slots available
|
|
|
|
* @bus_nr: ipack bus number
|
2012-05-18 03:10:05 -06:00
|
|
|
* @ops: bus operations for the mezzanine drivers
|
2012-05-09 07:27:19 -06:00
|
|
|
*/
|
|
|
|
struct ipack_bus_device {
|
2012-05-18 03:10:05 -06:00
|
|
|
struct device *parent;
|
2012-05-09 07:27:19 -06:00
|
|
|
int slots;
|
|
|
|
int bus_nr;
|
2012-09-10 12:14:01 -06:00
|
|
|
const struct ipack_bus_ops *ops;
|
2012-05-09 07:27:19 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* ipack_bus_register -- register a new ipack bus
|
|
|
|
*
|
2012-05-18 03:10:05 -06:00
|
|
|
* @parent: pointer to the parent device, if any.
|
|
|
|
* @slots: number of slots available in the bus device.
|
|
|
|
* @ops: bus operations for the mezzanine drivers.
|
|
|
|
*
|
|
|
|
* The carrier board device should call this function to register itself as
|
|
|
|
* available bus device in ipack.
|
2012-05-09 07:27:19 -06:00
|
|
|
*/
|
2012-05-18 03:10:05 -06:00
|
|
|
struct ipack_bus_device *ipack_bus_register(struct device *parent, int slots,
|
2012-09-10 12:14:01 -06:00
|
|
|
const struct ipack_bus_ops *ops);
|
2012-05-09 07:27:19 -06:00
|
|
|
|
|
|
|
/**
|
|
|
|
* ipack_bus_unregister -- unregister an ipack bus
|
|
|
|
*/
|
|
|
|
int ipack_bus_unregister(struct ipack_bus_device *bus);
|
2012-05-18 03:10:05 -06:00
|
|
|
|
|
|
|
/**
|
|
|
|
* ipack_driver_register -- Register a new driver
|
|
|
|
*
|
|
|
|
* Called by a ipack driver to register itself as a driver
|
|
|
|
* that can manage ipack devices.
|
|
|
|
*/
|
2012-09-10 12:14:01 -06:00
|
|
|
int ipack_driver_register(struct ipack_driver *edrv, struct module *owner,
|
|
|
|
const char *name);
|
2012-05-18 03:10:05 -06:00
|
|
|
void ipack_driver_unregister(struct ipack_driver *edrv);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* ipack_device_register -- register a new mezzanine device
|
|
|
|
*
|
|
|
|
* @bus: ipack bus device it is plugged to.
|
|
|
|
* @slot: slot position in the bus device.
|
|
|
|
*
|
|
|
|
* Register a new ipack device (mezzanine device). The call is done by
|
|
|
|
* the carrier device driver.
|
|
|
|
*/
|
2012-09-13 04:32:21 -06:00
|
|
|
struct ipack_device *ipack_device_register(struct ipack_bus_device *bus, int slot);
|
2012-05-18 03:10:05 -06:00
|
|
|
void ipack_device_unregister(struct ipack_device *dev);
|
2012-09-04 09:01:13 -06:00
|
|
|
|
|
|
|
/**
|
|
|
|
* DEFINE_IPACK_DEVICE_TABLE - macro used to describe a IndustryPack table
|
|
|
|
* @_table: device table name
|
|
|
|
*
|
|
|
|
* This macro is used to create a struct ipack_device_id array (a device table)
|
|
|
|
* in a generic manner.
|
|
|
|
*/
|
|
|
|
#define DEFINE_IPACK_DEVICE_TABLE(_table) \
|
|
|
|
const struct ipack_device_id _table[] __devinitconst
|
|
|
|
|
|
|
|
/**
|
|
|
|
* IPACK_DEVICE - macro used to describe a specific IndustryPack device
|
|
|
|
* @_format: the format version (currently either 1 or 2, 8 bit value)
|
|
|
|
* @vend: the 8 or 24 bit IndustryPack Vendor ID
|
|
|
|
* @dev: the 8 or 16 bit IndustryPack Device ID
|
|
|
|
*
|
|
|
|
* This macro is used to create a struct ipack_device_id that matches a specific
|
|
|
|
* device.
|
|
|
|
*/
|
|
|
|
#define IPACK_DEVICE(_format, vend, dev) \
|
|
|
|
.format = (_format), \
|
|
|
|
.vendor = (vend), \
|
|
|
|
.device = (dev)
|