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