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 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
  24 #include <linux/dmaengine.h>
  25 #endif
  26
  27 #define RIO_NO_HOPCOUNT         -1
  28 #define RIO_INVALID_DESTID      0xffff
  29
  30 #define RIO_MAX_MPORTS          8
  31 #define RIO_MAX_MPORT_RESOURCES 16
  32 #define RIO_MAX_DEV_RESOURCES   16
  33 #define RIO_MAX_MPORT_NAME      40
  34
  35 #define RIO_GLOBAL_TABLE        0xff    /* Indicates access of a switch's
  36                                            global routing table if it
  37                                            has multiple (or per port)
  38                                            tables */
  39
  40 #define RIO_INVALID_ROUTE       0xff    /* Indicates that a route table
  41                                            entry is invalid (no route
  42                                            exists for the device ID) */
  43
  44 #define RIO_MAX_ROUTE_ENTRIES(size)     (size ? (1 << 16) : (1 << 8))
  45 #define RIO_ANY_DESTID(size)            (size ? 0xffff : 0xff)
  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  *      2       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 #define RIO_PW_MSG_SIZE         64
  73
  74 /*
  75  * A component tag value (stored in the component tag CSR) is used as device's
  76  * unique identifier assigned during enumeration. Besides being used for
  77  * identifying switches (which do not have device ID register), it also is used
  78  * by error management notification and therefore has to be assigned
  79  * to endpoints as well.
  80  */
  81 #define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */
  82 #define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */
  83
  84 extern struct bus_type rio_bus_type;
  85 extern struct device rio_bus;
  86
  87 struct rio_mport;
  88 struct rio_dev;
  89 union rio_pw_msg;
  90
  91 /**
  92  * struct rio_switch - RIO switch info
  93  * @node: Node in global list of switches
  94  * @switchid: Switch ID that is unique across a network
  95  * @route_table: Copy of switch routing table
  96  * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0
  97  * @ops: pointer to switch-specific operations
  98  * @lock: lock to serialize operations updates
  99  * @nextdev: Array of per-port pointers to the next attached device
 100  */
 101 struct rio_switch {
 102         struct list_head node;
 103         u16 switchid;
 104         u8 *route_table;
 105         u32 port_ok;
 106         struct rio_switch_ops *ops;
 107         spinlock_t lock;
 108         struct rio_dev *nextdev[0];
 109 };
 110
 111 /**
 112  * struct rio_switch_ops - Per-switch operations
 113  * @owner: The module owner of this structure
 114  * @add_entry: Callback for switch-specific route add function
 115  * @get_entry: Callback for switch-specific route get function
 116  * @clr_table: Callback for switch-specific clear route table function
 117  * @set_domain: Callback for switch-specific domain setting function
 118  * @get_domain: Callback for switch-specific domain get function
 119  * @em_init: Callback for switch-specific error management init function
 120  * @em_handle: Callback for switch-specific error management handler function
 121  *
 122  * Defines the operations that are necessary to initialize/control
 123  * a particular RIO switch device.
 124  */
 125 struct rio_switch_ops {
 126         struct module *owner;
 127         int (*add_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,
 128                           u16 table, u16 route_destid, u8 route_port);
 129         int (*get_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,
 130                           u16 table, u16 route_destid, u8 *route_port);
 131         int (*clr_table) (struct rio_mport *mport, u16 destid, u8 hopcount,
 132                           u16 table);
 133         int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
 134                            u8 sw_domain);
 135         int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
 136                            u8 *sw_domain);
 137         int (*em_init) (struct rio_dev *dev);
 138         int (*em_handle) (struct rio_dev *dev, u8 swport);
 139 };
 140
 141 /**
 142  * struct rio_dev - RIO device info
 143  * @global_list: Node in list of all RIO devices
 144  * @net_list: Node in list of RIO devices in a network
 145  * @net: Network this device is a part of
 146  * @do_enum: Enumeration flag
 147  * @did: Device ID
 148  * @vid: Vendor ID
 149  * @device_rev: Device revision
 150  * @asm_did: Assembly device ID
 151  * @asm_vid: Assembly vendor ID
 152  * @asm_rev: Assembly revision
 153  * @efptr: Extended feature pointer
 154  * @pef: Processing element features
 155  * @swpinfo: Switch port info
 156  * @src_ops: Source operation capabilities
 157  * @dst_ops: Destination operation capabilities
 158  * @comp_tag: RIO component tag
 159  * @phys_efptr: RIO device extended features pointer
 160  * @em_efptr: RIO Error Management features pointer
 161  * @dma_mask: Mask of bits of RIO address this device implements
 162  * @driver: Driver claiming this device
 163  * @dev: Device model device
 164  * @riores: RIO resources this device owns
 165  * @pwcback: port-write callback function for this device
 166  * @destid: Network destination ID (or associated destid for switch)
 167  * @hopcount: Hopcount to this device
 168  * @prev: Previous RIO device connected to the current one
 169  * @rswitch: struct rio_switch (if valid for this device)
 170  */
 171 struct rio_dev {
 172         struct list_head global_list;   /* node in list of all RIO devices */
 173         struct list_head net_list;      /* node in per net list */
 174         struct rio_net *net;    /* RIO net this device resides in */
 175         bool do_enum;
 176         u16 did;
 177         u16 vid;
 178         u32 device_rev;
 179         u16 asm_did;
 180         u16 asm_vid;
 181         u16 asm_rev;
 182         u16 efptr;
 183         u32 pef;
 184         u32 swpinfo;
 185         u32 src_ops;
 186         u32 dst_ops;
 187         u32 comp_tag;
 188         u32 phys_efptr;
 189         u32 em_efptr;
 190         u64 dma_mask;
 191         struct rio_driver *driver;      /* RIO driver claiming this device */
 192         struct device dev;      /* LDM device structure */
 193         struct resource riores[RIO_MAX_DEV_RESOURCES];
 194         int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
 195         u16 destid;
 196         u8 hopcount;
 197         struct rio_dev *prev;
 198         struct rio_switch rswitch[0];   /* RIO switch info */
 199 };
 200
 201 #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
 202 #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
 203 #define to_rio_dev(n) container_of(n, struct rio_dev, dev)
 204 #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
 205
 206 /**
 207  * struct rio_msg - RIO message event
 208  * @res: Mailbox resource
 209  * @mcback: Message event callback
 210  */
 211 struct rio_msg {
 212         struct resource *res;
 213         void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
 214 };
 215
 216 /**
 217  * struct rio_dbell - RIO doorbell event
 218  * @node: Node in list of doorbell events
 219  * @res: Doorbell resource
 220  * @dinb: Doorbell event callback
 221  * @dev_id: Device specific pointer to pass on event
 222  */
 223 struct rio_dbell {
 224         struct list_head node;
 225         struct resource *res;
 226         void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
 227         void *dev_id;
 228 };
 229
 230 enum rio_phy_type {
 231         RIO_PHY_PARALLEL,
 232         RIO_PHY_SERIAL,
 233 };
 234
 235 /**
 236  * struct rio_mport - RIO master port info
 237  * @dbells: List of doorbell events
 238  * @node: Node in global list of master ports
 239  * @nnode: Node in network list of master ports
 240  * @iores: I/O mem resource that this master port interface owns
 241  * @riores: RIO resources that this master port interfaces owns
 242  * @inb_msg: RIO inbound message event descriptors
 243  * @outb_msg: RIO outbound message event descriptors
 244  * @host_deviceid: Host device ID associated with this master port
 245  * @ops: configuration space functions
 246  * @id: Port ID, unique among all ports
 247  * @index: Port index, unique among all port interfaces of the same type
 248  * @sys_size: RapidIO common transport system size
 249  * @phy_type: RapidIO phy type
 250  * @phys_efptr: RIO port extended features pointer
 251  * @name: Port name string
 252  * @priv: Master port private data
 253  * @dma: DMA device associated with mport
 254  * @nscan: RapidIO network enumeration/discovery operations
 255  */
 256 struct rio_mport {
 257         struct list_head dbells;        /* list of doorbell events */
 258         struct list_head node;  /* node in global list of ports */
 259         struct list_head nnode; /* node in net list of ports */
 260         struct resource iores;
 261         struct resource riores[RIO_MAX_MPORT_RESOURCES];
 262         struct rio_msg inb_msg[RIO_MAX_MBOX];
 263         struct rio_msg outb_msg[RIO_MAX_MBOX];
 264         int host_deviceid;      /* Host device ID */
 265         struct rio_ops *ops;    /* low-level architecture-dependent routines */
 266         unsigned char id;       /* port ID, unique among all ports */
 267         unsigned char index;    /* port index, unique among all port
 268                                    interfaces of the same type */
 269         unsigned int sys_size;  /* RapidIO common transport system size.
 270                                  * 0 - Small size. 256 devices.
 271                                  * 1 - Large size, 65536 devices.
 272                                  */
 273         enum rio_phy_type phy_type;     /* RapidIO phy type */
 274         u32 phys_efptr;
 275         unsigned char name[RIO_MAX_MPORT_NAME];
 276         void *priv;             /* Master port private data */
 277 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
 278         struct dma_device       dma;
 279 #endif
 280         struct rio_scan *nscan;
 281 };
 282
 283 /*
 284  * Enumeration/discovery control flags
 285  */
 286 #define RIO_SCAN_ENUM_NO_WAIT   0x00000001 /* Do not wait for enum completed */
 287
 288 struct rio_id_table {
 289         u16 start;      /* logical minimal id */
 290         u32 max;        /* max number of IDs in table */
 291         spinlock_t lock;
 292         unsigned long *table;
 293 };
 294
 295 /**
 296  * struct rio_net - RIO network info
 297  * @node: Node in global list of RIO networks
 298  * @devices: List of devices in this network
 299  * @switches: List of switches in this netowrk
 300  * @mports: List of master ports accessing this network
 301  * @hport: Default port for accessing this network
 302  * @id: RIO network ID
 303  * @destid_table: destID allocation table
 304  */
 305 struct rio_net {
 306         struct list_head node;  /* node in list of networks */
 307         struct list_head devices;       /* list of devices in this net */
 308         struct list_head switches;      /* list of switches in this net */
 309         struct list_head mports;        /* list of ports accessing net */
 310         struct rio_mport *hport;        /* primary port for accessing net */
 311         unsigned char id;       /* RIO network ID */
 312         struct rio_id_table destid_table;  /* destID allocation table */
 313 };
 314
 315 /* Low-level architecture-dependent routines */
 316
 317 /**
 318  * struct rio_ops - Low-level RIO configuration space operations
 319  * @lcread: Callback to perform local (master port) read of config space.
 320  * @lcwrite: Callback to perform local (master port) write of config space.
 321  * @cread: Callback to perform network read of config space.
 322  * @cwrite: Callback to perform network write of config space.
 323  * @dsend: Callback to send a doorbell message.
 324  * @pwenable: Callback to enable/disable port-write message handling.
 325  * @open_outb_mbox: Callback to initialize outbound mailbox.
 326  * @close_outb_mbox: Callback to shut down outbound mailbox.
 327  * @open_inb_mbox: Callback to initialize inbound mailbox.
 328  * @close_inb_mbox: Callback to shut down inbound mailbox.
 329  * @add_outb_message: Callback to add a message to an outbound mailbox queue.
 330  * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue.
 331  * @get_inb_message: Callback to get a message from an inbound mailbox queue.
 332  * @map_inb: Callback to map RapidIO address region into local memory space.
 333  * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb().
 334  */
 335 struct rio_ops {
 336         int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
 337                         u32 *data);
 338         int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
 339                         u32 data);
 340         int (*cread) (struct rio_mport *mport, int index, u16 destid,
 341                         u8 hopcount, u32 offset, int len, u32 *data);
 342         int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
 343                         u8 hopcount, u32 offset, int len, u32 data);
 344         int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
 345         int (*pwenable) (struct rio_mport *mport, int enable);
 346         int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id,
 347                               int mbox, int entries);
 348         void (*close_outb_mbox)(struct rio_mport *mport, int mbox);
 349         int  (*open_inb_mbox)(struct rio_mport *mport, void *dev_id,
 350                              int mbox, int entries);
 351         void (*close_inb_mbox)(struct rio_mport *mport, int mbox);
 352         int  (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev,
 353                                  int mbox, void *buffer, size_t len);
 354         int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf);
 355         void *(*get_inb_message)(struct rio_mport *mport, int mbox);
 356         int (*map_inb)(struct rio_mport *mport, dma_addr_t lstart,
 357                         u64 rstart, u32 size, u32 flags);
 358         void (*unmap_inb)(struct rio_mport *mport, dma_addr_t lstart);
 359 };
 360
 361 #define RIO_RESOURCE_MEM        0x00000100
 362 #define RIO_RESOURCE_DOORBELL   0x00000200
 363 #define RIO_RESOURCE_MAILBOX    0x00000400
 364
 365 #define RIO_RESOURCE_CACHEABLE  0x00010000
 366 #define RIO_RESOURCE_PCI        0x00020000
 367
 368 #define RIO_RESOURCE_BUSY       0x80000000
 369
 370 /**
 371  * struct rio_driver - RIO driver info
 372  * @node: Node in list of drivers
 373  * @name: RIO driver name
 374  * @id_table: RIO device ids to be associated with this driver
 375  * @probe: RIO device inserted
 376  * @remove: RIO device removed
 377  * @suspend: RIO device suspended
 378  * @resume: RIO device awakened
 379  * @enable_wake: RIO device enable wake event
 380  * @driver: LDM driver struct
 381  *
 382  * Provides info on a RIO device driver for insertion/removal and
 383  * power management purposes.
 384  */
 385 struct rio_driver {
 386         struct list_head node;
 387         char *name;
 388         const struct rio_device_id *id_table;
 389         int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
 390         void (*remove) (struct rio_dev * dev);
 391         int (*suspend) (struct rio_dev * dev, u32 state);
 392         int (*resume) (struct rio_dev * dev);
 393         int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
 394         struct device_driver driver;
 395 };
 396
 397 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
 398
 399 /**
 400  * struct rio_device_id - RIO device identifier
 401  * @did: RIO device ID
 402  * @vid: RIO vendor ID
 403  * @asm_did: RIO assembly device ID
 404  * @asm_vid: RIO assembly vendor ID
 405  *
 406  * Identifies a RIO device based on both the device/vendor IDs and
 407  * the assembly device/vendor IDs.
 408  */
 409 struct rio_device_id {
 410         u16 did, vid;
 411         u16 asm_did, asm_vid;
 412 };
 413
 414 union rio_pw_msg {
 415         struct {
 416                 u32 comptag;    /* Component Tag CSR */
 417                 u32 errdetect;  /* Port N Error Detect CSR */
 418                 u32 is_port;    /* Implementation specific + PortID */
 419                 u32 ltlerrdet;  /* LTL Error Detect CSR */
 420                 u32 padding[12];
 421         } em;
 422         u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
 423 };
 424
 425 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
 426
 427 /*
 428  * enum rio_write_type - RIO write transaction types used in DMA transfers
 429  *
 430  * Note: RapidIO specification defines write (NWRITE) and
 431  * write-with-response (NWRITE_R) data transfer operations.
 432  * Existing DMA controllers that service RapidIO may use one of these operations
 433  * for entire data transfer or their combination with only the last data packet
 434  * requires response.
 435  */
 436 enum rio_write_type {
 437         RDW_DEFAULT,            /* default method used by DMA driver */
 438         RDW_ALL_NWRITE,         /* all packets use NWRITE */
 439         RDW_ALL_NWRITE_R,       /* all packets use NWRITE_R */
 440         RDW_LAST_NWRITE_R,      /* last packet uses NWRITE_R, others - NWRITE */
 441 };
 442
 443 struct rio_dma_ext {
 444         u16 destid;
 445         u64 rio_addr;   /* low 64-bits of 66-bit RapidIO address */
 446         u8  rio_addr_u;  /* upper 2-bits of 66-bit RapidIO address */
 447         enum rio_write_type wr_type; /* preferred RIO write operation type */
 448 };
 449
 450 struct rio_dma_data {
 451         /* Local data (as scatterlist) */
 452         struct scatterlist      *sg;    /* I/O scatter list */
 453         unsigned int            sg_len; /* size of scatter list */
 454         /* Remote device address (flat buffer) */
 455         u64 rio_addr;   /* low 64-bits of 66-bit RapidIO address */
 456         u8  rio_addr_u;  /* upper 2-bits of 66-bit RapidIO address */
 457         enum rio_write_type wr_type; /* preferred RIO write operation type */
 458 };
 459
 460 static inline struct rio_mport *dma_to_mport(struct dma_device *ddev)
 461 {
 462         return container_of(ddev, struct rio_mport, dma);
 463 }
 464 #endif /* CONFIG_RAPIDIO_DMA_ENGINE */
 465
 466 /**
 467  * struct rio_scan - RIO enumeration and discovery operations
 468  * @owner: The module owner of this structure
 469  * @enumerate: Callback to perform RapidIO fabric enumeration.
 470  * @discover: Callback to perform RapidIO fabric discovery.
 471  */
 472 struct rio_scan {
 473         struct module *owner;
 474         int (*enumerate)(struct rio_mport *mport, u32 flags);
 475         int (*discover)(struct rio_mport *mport, u32 flags);
 476 };
 477
 478 /**
 479  * struct rio_scan_node - list node to register RapidIO enumeration and
 480  * discovery methods with RapidIO core.
 481  * @mport_id: ID of an mport (net) serviced by this enumerator
 482  * @node: node in global list of registered enumerators
 483  * @ops: RIO enumeration and discovery operations
 484  */
 485 struct rio_scan_node {
 486         int mport_id;
 487         struct list_head node;
 488         struct rio_scan *ops;
 489 };
 490
 491 /* Architecture and hardware-specific functions */
 492 extern int rio_register_mport(struct rio_mport *);
 493 extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
 494 extern void rio_close_inb_mbox(struct rio_mport *, int);
 495 extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
 496 extern void rio_close_outb_mbox(struct rio_mport *, int);
 497
 498 #endif                          /* LINUX_RIO_H */