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 #include <linux/types.h>
  18 #include <linux/ioport.h>
  19 #include <linux/list.h>
  20 #include <linux/errno.h>
  21 #include <linux/device.h>
  22 #include <linux/rio_regs.h>
  23
  24 #define RIO_NO_HOPCOUNT         -1
  25 #define RIO_INVALID_DESTID      0xffff
  26
  27 #define RIO_MAX_MPORT_RESOURCES 16
  28 #define RIO_MAX_DEV_RESOURCES   16
  29
  30 #define RIO_GLOBAL_TABLE        0xff    /* Indicates access of a switch's
  31                                            global routing table if it
  32                                            has multiple (or per port)
  33                                            tables */
  34
  35 #define RIO_INVALID_ROUTE       0xff    /* Indicates that a route table
  36                                            entry is invalid (no route
  37                                            exists for the device ID) */
  38
  39 #define RIO_MAX_ROUTE_ENTRIES(size)     (size ? (1 << 16) : (1 << 8))
  40 #define RIO_ANY_DESTID(size)            (size ? 0xffff : 0xff)
  41
  42 #define RIO_MAX_MBOX            4
  43 #define RIO_MAX_MSG_SIZE        0x1000
  44
  45 /*
  46  * Error values that may be returned by RIO functions.
  47  */
  48 #define RIO_SUCCESSFUL                  0x00
  49 #define RIO_BAD_SIZE                    0x81
  50
  51 /*
  52  * For RIO devices, the region numbers are assigned this way:
  53  *
  54  *      0       RapidIO outbound doorbells
  55  *      1-15    RapidIO memory regions
  56  *
  57  * For RIO master ports, the region number are assigned this way:
  58  *
  59  *      0       RapidIO inbound doorbells
  60  *      1       RapidIO inbound mailboxes
  61  *      1       RapidIO outbound mailboxes
  62  */
  63 #define RIO_DOORBELL_RESOURCE   0
  64 #define RIO_INB_MBOX_RESOURCE   1
  65 #define RIO_OUTB_MBOX_RESOURCE  2
  66
  67 #define RIO_PW_MSG_SIZE         64
  68
  69 extern struct bus_type rio_bus_type;
  70 extern struct device rio_bus;
  71 extern struct list_head rio_devices;    /* list of all devices */
  72
  73 struct rio_mport;
  74 struct rio_dev;
  75 union rio_pw_msg;
  76
  77 /**
  78  * struct rio_switch - RIO switch info
  79  * @node: Node in global list of switches
  80  * @switchid: Switch ID that is unique across a network
  81  * @route_table: Copy of switch routing table
  82  * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0
  83  * @add_entry: Callback for switch-specific route add function
  84  * @get_entry: Callback for switch-specific route get function
  85  * @clr_table: Callback for switch-specific clear route table function
  86  * @set_domain: Callback for switch-specific domain setting function
  87  * @get_domain: Callback for switch-specific domain get function
  88  * @em_init: Callback for switch-specific error management init function
  89  * @em_handle: Callback for switch-specific error management handler function
  90  * @sw_sysfs: Callback that initializes switch-specific sysfs attributes
  91  * @nextdev: Array of per-port pointers to the next attached device
  92  */
  93 struct rio_switch {
  94         struct list_head node;
  95         u16 switchid;
  96         u8 *route_table;
  97         u32 port_ok;
  98         int (*add_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,
  99                           u16 table, u16 route_destid, u8 route_port);
 100         int (*get_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,
 101                           u16 table, u16 route_destid, u8 *route_port);
 102         int (*clr_table) (struct rio_mport *mport, u16 destid, u8 hopcount,
 103                           u16 table);
 104         int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
 105                            u8 sw_domain);
 106         int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
 107                            u8 *sw_domain);
 108         int (*em_init) (struct rio_dev *dev);
 109         int (*em_handle) (struct rio_dev *dev, u8 swport);
 110         int (*sw_sysfs) (struct rio_dev *dev, int create);
 111         struct rio_dev *nextdev[0];
 112 };
 113
 114 /**
 115  * struct rio_dev - RIO device info
 116  * @global_list: Node in list of all RIO devices
 117  * @net_list: Node in list of RIO devices in a network
 118  * @net: Network this device is a part of
 119  * @did: Device ID
 120  * @vid: Vendor ID
 121  * @device_rev: Device revision
 122  * @asm_did: Assembly device ID
 123  * @asm_vid: Assembly vendor ID
 124  * @asm_rev: Assembly revision
 125  * @efptr: Extended feature pointer
 126  * @pef: Processing element features
 127  * @swpinfo: Switch port info
 128  * @src_ops: Source operation capabilities
 129  * @dst_ops: Destination operation capabilities
 130  * @comp_tag: RIO component tag
 131  * @phys_efptr: RIO device extended features pointer
 132  * @em_efptr: RIO Error Management features pointer
 133  * @dma_mask: Mask of bits of RIO address this device implements
 134  * @driver: Driver claiming this device
 135  * @dev: Device model device
 136  * @riores: RIO resources this device owns
 137  * @pwcback: port-write callback function for this device
 138  * @destid: Network destination ID (or associated destid for switch)
 139  * @hopcount: Hopcount to this device
 140  * @prev: Previous RIO device connected to the current one
 141  * @rswitch: struct rio_switch (if valid for this device)
 142  */
 143 struct rio_dev {
 144         struct list_head global_list;   /* node in list of all RIO devices */
 145         struct list_head net_list;      /* node in per net list */
 146         struct rio_net *net;    /* RIO net this device resides in */
 147         u16 did;
 148         u16 vid;
 149         u32 device_rev;
 150         u16 asm_did;
 151         u16 asm_vid;
 152         u16 asm_rev;
 153         u16 efptr;
 154         u32 pef;
 155         u32 swpinfo;
 156         u32 src_ops;
 157         u32 dst_ops;
 158         u32 comp_tag;
 159         u32 phys_efptr;
 160         u32 em_efptr;
 161         u64 dma_mask;
 162         struct rio_driver *driver;      /* RIO driver claiming this device */
 163         struct device dev;      /* LDM device structure */
 164         struct resource riores[RIO_MAX_DEV_RESOURCES];
 165         int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
 166         u16 destid;
 167         u8 hopcount;
 168         struct rio_dev *prev;
 169         struct rio_switch rswitch[0];   /* RIO switch info */
 170 };
 171
 172 #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
 173 #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
 174 #define to_rio_dev(n) container_of(n, struct rio_dev, dev)
 175 #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
 176
 177 /**
 178  * struct rio_msg - RIO message event
 179  * @res: Mailbox resource
 180  * @mcback: Message event callback
 181  */
 182 struct rio_msg {
 183         struct resource *res;
 184         void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
 185 };
 186
 187 /**
 188  * struct rio_dbell - RIO doorbell event
 189  * @node: Node in list of doorbell events
 190  * @res: Doorbell resource
 191  * @dinb: Doorbell event callback
 192  * @dev_id: Device specific pointer to pass on event
 193  */
 194 struct rio_dbell {
 195         struct list_head node;
 196         struct resource *res;
 197         void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
 198         void *dev_id;
 199 };
 200
 201 enum rio_phy_type {
 202         RIO_PHY_PARALLEL,
 203         RIO_PHY_SERIAL,
 204 };
 205
 206 /**
 207  * struct rio_mport - RIO master port info
 208  * @dbells: List of doorbell events
 209  * @node: Node in global list of master ports
 210  * @nnode: Node in network list of master ports
 211  * @iores: I/O mem resource that this master port interface owns
 212  * @riores: RIO resources that this master port interfaces owns
 213  * @inb_msg: RIO inbound message event descriptors
 214  * @outb_msg: RIO outbound message event descriptors
 215  * @host_deviceid: Host device ID associated with this master port
 216  * @ops: configuration space functions
 217  * @id: Port ID, unique among all ports
 218  * @index: Port index, unique among all port interfaces of the same type
 219  * @sys_size: RapidIO common transport system size
 220  * @phy_type: RapidIO phy type
 221  * @phys_efptr: RIO port extended features pointer
 222  * @name: Port name string
 223  * @priv: Master port private data
 224  */
 225 struct rio_mport {
 226         struct list_head dbells;        /* list of doorbell events */
 227         struct list_head node;  /* node in global list of ports */
 228         struct list_head nnode; /* node in net list of ports */
 229         struct resource iores;
 230         struct resource riores[RIO_MAX_MPORT_RESOURCES];
 231         struct rio_msg inb_msg[RIO_MAX_MBOX];
 232         struct rio_msg outb_msg[RIO_MAX_MBOX];
 233         int host_deviceid;      /* Host device ID */
 234         struct rio_ops *ops;    /* maintenance transaction functions */
 235         unsigned char id;       /* port ID, unique among all ports */
 236         unsigned char index;    /* port index, unique among all port
 237                                    interfaces of the same type */
 238         unsigned int sys_size;  /* RapidIO common transport system size.
 239                                  * 0 - Small size. 256 devices.
 240                                  * 1 - Large size, 65536 devices.
 241                                  */
 242         enum rio_phy_type phy_type;     /* RapidIO phy type */
 243         u32 phys_efptr;
 244         unsigned char name[40];
 245         void *priv;             /* Master port private data */
 246 };
 247
 248 /**
 249  * struct rio_net - RIO network info
 250  * @node: Node in global list of RIO networks
 251  * @devices: List of devices in this network
 252  * @mports: List of master ports accessing this network
 253  * @hport: Default port for accessing this network
 254  * @id: RIO network ID
 255  */
 256 struct rio_net {
 257         struct list_head node;  /* node in list of networks */
 258         struct list_head devices;       /* list of devices in this net */
 259         struct list_head mports;        /* list of ports accessing net */
 260         struct rio_mport *hport;        /* primary port for accessing net */
 261         unsigned char id;       /* RIO network ID */
 262 };
 263
 264 /* Definitions used by switch sysfs initialization callback */
 265 #define RIO_SW_SYSFS_CREATE     1       /* Create switch attributes */
 266 #define RIO_SW_SYSFS_REMOVE     0       /* Remove switch attributes */
 267
 268 /* Low-level architecture-dependent routines */
 269
 270 /**
 271  * struct rio_ops - Low-level RIO configuration space operations
 272  * @lcread: Callback to perform local (master port) read of config space.
 273  * @lcwrite: Callback to perform local (master port) write of config space.
 274  * @cread: Callback to perform network read of config space.
 275  * @cwrite: Callback to perform network write of config space.
 276  * @dsend: Callback to send a doorbell message.
 277  * @pwenable: Callback to enable/disable port-write message handling.
 278  */
 279 struct rio_ops {
 280         int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
 281                         u32 *data);
 282         int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
 283                         u32 data);
 284         int (*cread) (struct rio_mport *mport, int index, u16 destid,
 285                         u8 hopcount, u32 offset, int len, u32 *data);
 286         int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
 287                         u8 hopcount, u32 offset, int len, u32 data);
 288         int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
 289         int (*pwenable) (struct rio_mport *mport, int enable);
 290 };
 291
 292 #define RIO_RESOURCE_MEM        0x00000100
 293 #define RIO_RESOURCE_DOORBELL   0x00000200
 294 #define RIO_RESOURCE_MAILBOX    0x00000400
 295
 296 #define RIO_RESOURCE_CACHEABLE  0x00010000
 297 #define RIO_RESOURCE_PCI        0x00020000
 298
 299 #define RIO_RESOURCE_BUSY       0x80000000
 300
 301 /**
 302  * struct rio_driver - RIO driver info
 303  * @node: Node in list of drivers
 304  * @name: RIO driver name
 305  * @id_table: RIO device ids to be associated with this driver
 306  * @probe: RIO device inserted
 307  * @remove: RIO device removed
 308  * @suspend: RIO device suspended
 309  * @resume: RIO device awakened
 310  * @enable_wake: RIO device enable wake event
 311  * @driver: LDM driver struct
 312  *
 313  * Provides info on a RIO device driver for insertion/removal and
 314  * power management purposes.
 315  */
 316 struct rio_driver {
 317         struct list_head node;
 318         char *name;
 319         const struct rio_device_id *id_table;
 320         int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
 321         void (*remove) (struct rio_dev * dev);
 322         int (*suspend) (struct rio_dev * dev, u32 state);
 323         int (*resume) (struct rio_dev * dev);
 324         int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
 325         struct device_driver driver;
 326 };
 327
 328 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
 329
 330 /**
 331  * struct rio_device_id - RIO device identifier
 332  * @did: RIO device ID
 333  * @vid: RIO vendor ID
 334  * @asm_did: RIO assembly device ID
 335  * @asm_vid: RIO assembly vendor ID
 336  *
 337  * Identifies a RIO device based on both the device/vendor IDs and
 338  * the assembly device/vendor IDs.
 339  */
 340 struct rio_device_id {
 341         u16 did, vid;
 342         u16 asm_did, asm_vid;
 343 };
 344
 345 /**
 346  * struct rio_switch_ops - Per-switch operations
 347  * @vid: RIO vendor ID
 348  * @did: RIO device ID
 349  * @init_hook: Callback that performs switch device initialization
 350  *
 351  * Defines the operations that are necessary to initialize/control
 352  * a particular RIO switch device.
 353  */
 354 struct rio_switch_ops {
 355         u16 vid, did;
 356         int (*init_hook) (struct rio_dev *rdev, int do_enum);
 357 };
 358
 359 union rio_pw_msg {
 360         struct {
 361                 u32 comptag;    /* Component Tag CSR */
 362                 u32 errdetect;  /* Port N Error Detect CSR */
 363                 u32 is_port;    /* Implementation specific + PortID */
 364                 u32 ltlerrdet;  /* LTL Error Detect CSR */
 365                 u32 padding[12];
 366         } em;
 367         u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
 368 };
 369
 370 /* Architecture and hardware-specific functions */
 371 extern int rio_init_mports(void);
 372 extern void rio_register_mport(struct rio_mport *);
 373 extern int rio_hw_add_outb_message(struct rio_mport *, struct rio_dev *, int,
 374                                    void *, size_t);
 375 extern int rio_hw_add_inb_buffer(struct rio_mport *, int, void *);
 376 extern void *rio_hw_get_inb_message(struct rio_mport *, int);
 377 extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
 378 extern void rio_close_inb_mbox(struct rio_mport *, int);
 379 extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
 380 extern void rio_close_outb_mbox(struct rio_mport *, int);
 381
 382 #endif                          /* LINUX_RIO_H */