include/linux/rio.h

   1 /*
   2  * RapidIO interconnect services
   3  * (RapidIO Interconnect Specification, http://www.rapidio.org)
   4  *
   5  * Copyright 2005 MontaVista Software, Inc.
   6  * Matt Porter <mporter@kernel.crashing.org>
   7  *
   8  * This program is free software; you can redistribute  it and/or modify it
   9  * under  the terms of  the GNU General  Public License as published by the
  10  * Free Software Foundation;  either version 2 of the  License, or (at your
  11  * option) any later version.
  12  */
  13
  14 #ifndef LINUX_RIO_H
  15 #define LINUX_RIO_H
  16
  17 #ifdef __KERNEL__
  18
  19 #include <linux/types.h>
  20 #include <linux/ioport.h>
  21 #include <linux/list.h>
  22 #include <linux/errno.h>
  23 #include <linux/device.h>
  24 #include <linux/rio_regs.h>
  25
  26 #define RIO_ANY_DESTID          0xff
  27 #define RIO_NO_HOPCOUNT         -1
  28
  29 #define RIO_MAX_MPORT_RESOURCES 16
  30 #define RIO_MAX_DEV_RESOURCES   16
  31
  32 #define RIO_GLOBAL_TABLE        0xff    /* Indicates access of a switch's
  33                                            global routing table if it
  34                                            has multiple (or per port)
  35                                            tables */
  36
  37 #define RIO_INVALID_ROUTE       0xff    /* Indicates that a route table
  38                                            entry is invalid (no route
  39                                            exists for the device ID) */
  40
  41 #ifdef CONFIG_RAPIDIO_8_BIT_TRANSPORT
  42 #define RIO_MAX_ROUTE_ENTRIES   (1 << 8)
  43 #else
  44 #define RIO_MAX_ROUTE_ENTRIES   (1 << 16)
  45 #endif
  46
  47 #define RIO_MAX_MBOX            4
  48 #define RIO_MAX_MSG_SIZE        0x1000
  49
  50 /*
  51  * Error values that may be returned by RIO functions.
  52  */
  53 #define RIO_SUCCESSFUL                  0x00
  54 #define RIO_BAD_SIZE                    0x81
  55
  56 /*
  57  * For RIO devices, the region numbers are assigned this way:
  58  *
  59  *      0       RapidIO outbound doorbells
  60  *      1-15    RapidIO memory regions
  61  *
  62  * For RIO master ports, the region number are assigned this way:
  63  *
  64  *      0       RapidIO inbound doorbells
  65  *      1       RapidIO inbound mailboxes
  66  *      1       RapidIO outbound mailboxes
  67  */
  68 #define RIO_DOORBELL_RESOURCE   0
  69 #define RIO_INB_MBOX_RESOURCE   1
  70 #define RIO_OUTB_MBOX_RESOURCE  2
  71
  72 extern struct bus_type rio_bus_type;
  73 extern struct list_head rio_devices;    /* list of all devices */
  74
  75 struct rio_mport;
  76
  77 /**
  78  * struct rio_dev - RIO device info
  79  * @global_list: Node in list of all RIO devices
  80  * @net_list: Node in list of RIO devices in a network
  81  * @net: Network this device is a part of
  82  * @did: Device ID
  83  * @vid: Vendor ID
  84  * @device_rev: Device revision
  85  * @asm_did: Assembly device ID
  86  * @asm_vid: Assembly vendor ID
  87  * @asm_rev: Assembly revision
  88  * @efptr: Extended feature pointer
  89  * @pef: Processing element features
  90  * @swpinfo: Switch port info
  91  * @src_ops: Source operation capabilities
  92  * @dst_ops: Destination operation capabilities
  93  * @dma_mask: Mask of bits of RIO address this device implements
  94  * @rswitch: Pointer to &struct rio_switch if valid for this device
  95  * @driver: Driver claiming this device
  96  * @dev: Device model device
  97  * @riores: RIO resources this device owns
  98  * @destid: Network destination ID
  99  */
 100 struct rio_dev {
 101         struct list_head global_list;   /* node in list of all RIO devices */
 102         struct list_head net_list;      /* node in per net list */
 103         struct rio_net *net;    /* RIO net this device resides in */
 104         u16 did;
 105         u16 vid;
 106         u32 device_rev;
 107         u16 asm_did;
 108         u16 asm_vid;
 109         u16 asm_rev;
 110         u16 efptr;
 111         u32 pef;
 112         u32 swpinfo;            /* Only used for switches */
 113         u32 src_ops;
 114         u32 dst_ops;
 115         u64 dma_mask;
 116         struct rio_switch *rswitch;     /* RIO switch info */
 117         struct rio_driver *driver;      /* RIO driver claiming this device */
 118         struct device dev;      /* LDM device structure */
 119         struct resource riores[RIO_MAX_DEV_RESOURCES];
 120         u16 destid;
 121 };
 122
 123 #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
 124 #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
 125 #define to_rio_dev(n) container_of(n, struct rio_dev, dev)
 126
 127 /**
 128  * struct rio_msg - RIO message event
 129  * @res: Mailbox resource
 130  * @mcback: Message event callback
 131  */
 132 struct rio_msg {
 133         struct resource *res;
 134         void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
 135 };
 136
 137 /**
 138  * struct rio_dbell - RIO doorbell event
 139  * @node: Node in list of doorbell events
 140  * @res: Doorbell resource
 141  * @dinb: Doorbell event callback
 142  * @dev_id: Device specific pointer to pass on event
 143  */
 144 struct rio_dbell {
 145         struct list_head node;
 146         struct resource *res;
 147         void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
 148         void *dev_id;
 149 };
 150
 151 /**
 152  * struct rio_mport - RIO master port info
 153  * @dbells: List of doorbell events
 154  * @node: Node in global list of master ports
 155  * @nnode: Node in network list of master ports
 156  * @iores: I/O mem resource that this master port interface owns
 157  * @riores: RIO resources that this master port interfaces owns
 158  * @inb_msg: RIO inbound message event descriptors
 159  * @outb_msg: RIO outbound message event descriptors
 160  * @host_deviceid: Host device ID associated with this master port
 161  * @ops: configuration space functions
 162  * @id: Port ID, unique among all ports
 163  * @index: Port index, unique among all port interfaces of the same type
 164  * @name: Port name string
 165  */
 166 struct rio_mport {
 167         struct list_head dbells;        /* list of doorbell events */
 168         struct list_head node;  /* node in global list of ports */
 169         struct list_head nnode; /* node in net list of ports */
 170         struct resource iores;
 171         struct resource riores[RIO_MAX_MPORT_RESOURCES];
 172         struct rio_msg inb_msg[RIO_MAX_MBOX];
 173         struct rio_msg outb_msg[RIO_MAX_MBOX];
 174         int host_deviceid;      /* Host device ID */
 175         struct rio_ops *ops;    /* maintenance transaction functions */
 176         unsigned char id;       /* port ID, unique among all ports */
 177         unsigned char index;    /* port index, unique among all port
 178                                    interfaces of the same type */
 179         unsigned char name[40];
 180 };
 181
 182 /**
 183  * struct rio_net - RIO network info
 184  * @node: Node in global list of RIO networks
 185  * @devices: List of devices in this network
 186  * @mports: List of master ports accessing this network
 187  * @hport: Default port for accessing this network
 188  * @id: RIO network ID
 189  */
 190 struct rio_net {
 191         struct list_head node;  /* node in list of networks */
 192         struct list_head devices;       /* list of devices in this net */
 193         struct list_head mports;        /* list of ports accessing net */
 194         struct rio_mport *hport;        /* primary port for accessing net */
 195         unsigned char id;       /* RIO network ID */
 196 };
 197
 198 /**
 199  * struct rio_switch - RIO switch info
 200  * @node: Node in global list of switches
 201  * @switchid: Switch ID that is unique across a network
 202  * @hopcount: Hopcount to this switch
 203  * @destid: Associated destid in the path
 204  * @route_table: Copy of switch routing table
 205  * @add_entry: Callback for switch-specific route add function
 206  * @get_entry: Callback for switch-specific route get function
 207  */
 208 struct rio_switch {
 209         struct list_head node;
 210         u16 switchid;
 211         u16 hopcount;
 212         u16 destid;
 213         u8 route_table[RIO_MAX_ROUTE_ENTRIES];
 214         int (*add_entry) (struct rio_mport * mport, u16 destid, u8 hopcount,
 215                           u16 table, u16 route_destid, u8 route_port);
 216         int (*get_entry) (struct rio_mport * mport, u16 destid, u8 hopcount,
 217                           u16 table, u16 route_destid, u8 * route_port);
 218 };
 219
 220 /* Low-level architecture-dependent routines */
 221
 222 /**
 223  * struct rio_ops - Low-level RIO configuration space operations
 224  * @lcread: Callback to perform local (master port) read of config space.
 225  * @lcwrite: Callback to perform local (master port) write of config space.
 226  * @cread: Callback to perform network read of config space.
 227  * @cwrite: Callback to perform network write of config space.
 228  * @dsend: Callback to send a doorbell message.
 229  */
 230 struct rio_ops {
 231         int (*lcread) (int index, u32 offset, int len, u32 * data);
 232         int (*lcwrite) (int index, u32 offset, int len, u32 data);
 233         int (*cread) (int index, u16 destid, u8 hopcount, u32 offset, int len,
 234                       u32 * data);
 235         int (*cwrite) (int index, u16 destid, u8 hopcount, u32 offset, int len,
 236                        u32 data);
 237         int (*dsend) (int index, u16 destid, u16 data);
 238 };
 239
 240 #define RIO_RESOURCE_MEM        0x00000100
 241 #define RIO_RESOURCE_DOORBELL   0x00000200
 242 #define RIO_RESOURCE_MAILBOX    0x00000400
 243
 244 #define RIO_RESOURCE_CACHEABLE  0x00010000
 245 #define RIO_RESOURCE_PCI        0x00020000
 246
 247 #define RIO_RESOURCE_BUSY       0x80000000
 248
 249 /**
 250  * struct rio_driver - RIO driver info
 251  * @node: Node in list of drivers
 252  * @name: RIO driver name
 253  * @id_table: RIO device ids to be associated with this driver
 254  * @probe: RIO device inserted
 255  * @remove: RIO device removed
 256  * @suspend: RIO device suspended
 257  * @resume: RIO device awakened
 258  * @enable_wake: RIO device enable wake event
 259  * @driver: LDM driver struct
 260  *
 261  * Provides info on a RIO device driver for insertion/removal and
 262  * power management purposes.
 263  */
 264 struct rio_driver {
 265         struct list_head node;
 266         char *name;
 267         const struct rio_device_id *id_table;
 268         int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
 269         void (*remove) (struct rio_dev * dev);
 270         int (*suspend) (struct rio_dev * dev, u32 state);
 271         int (*resume) (struct rio_dev * dev);
 272         int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
 273         struct device_driver driver;
 274 };
 275
 276 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
 277
 278 /**
 279  * struct rio_device_id - RIO device identifier
 280  * @did: RIO device ID
 281  * @vid: RIO vendor ID
 282  * @asm_did: RIO assembly device ID
 283  * @asm_vid: RIO assembly vendor ID
 284  *
 285  * Identifies a RIO device based on both the device/vendor IDs and
 286  * the assembly device/vendor IDs.
 287  */
 288 struct rio_device_id {
 289         u16 did, vid;
 290         u16 asm_did, asm_vid;
 291 };
 292
 293 /**
 294  * struct rio_route_ops - Per-switch route operations
 295  * @vid: RIO vendor ID
 296  * @did: RIO device ID
 297  * @add_hook: Callback that adds a route entry
 298  * @get_hook: Callback that gets a route entry
 299  *
 300  * Defines the operations that are necessary to manipulate the route
 301  * tables for a particular RIO switch device.
 302  */
 303 struct rio_route_ops {
 304         u16 vid, did;
 305         int (*add_hook) (struct rio_mport * mport, u16 destid, u8 hopcount,
 306                          u16 table, u16 route_destid, u8 route_port);
 307         int (*get_hook) (struct rio_mport * mport, u16 destid, u8 hopcount,
 308                          u16 table, u16 route_destid, u8 * route_port);
 309 };
 310
 311 /* Architecture and hardware-specific functions */
 312 extern int rio_init_mports(void);
 313 extern void rio_register_mport(struct rio_mport *);
 314 extern int rio_hw_add_outb_message(struct rio_mport *, struct rio_dev *, int,
 315                                    void *, size_t);
 316 extern int rio_hw_add_inb_buffer(struct rio_mport *, int, void *);
 317 extern void *rio_hw_get_inb_message(struct rio_mport *, int);
 318 extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
 319 extern void rio_close_inb_mbox(struct rio_mport *, int);
 320 extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
 321 extern void rio_close_outb_mbox(struct rio_mport *, int);
 322
 323 #endif                          /* __KERNEL__ */
 324 #endif                          /* LINUX_RIO_H */