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