blob: c64a0baf37c89483adbf87d272e3b04c185c5e6b [file] [log] [blame]
Matt Porter70a50eb2005-11-07 01:00:16 -08001/*
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
Matt Porter70a50eb2005-11-07 01:00:16 -080017#include <linux/types.h>
Matt Porter70a50eb2005-11-07 01:00:16 -080018#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>
Alexandre Bounine3bdbb622013-07-03 15:08:58 -070023#include <linux/mod_devicetable.h>
Alexandre Bouninee42d98e2012-05-31 16:26:38 -070024#ifdef CONFIG_RAPIDIO_DMA_ENGINE
25#include <linux/dmaengine.h>
26#endif
Matt Porter70a50eb2005-11-07 01:00:16 -080027
Matt Porter70a50eb2005-11-07 01:00:16 -080028#define RIO_NO_HOPCOUNT -1
Alexandre Bouninec70555b2007-02-10 01:46:47 -080029#define RIO_INVALID_DESTID 0xffff
Matt Porter70a50eb2005-11-07 01:00:16 -080030
Alexandre Bounine569fccb2011-03-23 16:43:05 -070031#define RIO_MAX_MPORTS 8
Matt Porter70a50eb2005-11-07 01:00:16 -080032#define RIO_MAX_MPORT_RESOURCES 16
33#define RIO_MAX_DEV_RESOURCES 16
Alexandre Bounineed43f442012-10-04 17:15:51 -070034#define RIO_MAX_MPORT_NAME 40
Matt Porter70a50eb2005-11-07 01:00:16 -080035
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
Zhang Weie0423232008-04-18 13:33:42 -070045#define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8))
46#define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff)
Matt Porter70a50eb2005-11-07 01:00:16 -080047
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
Chad Reesefdb8d562012-10-10 15:54:05 -070067 * 2 RapidIO outbound mailboxes
Matt Porter70a50eb2005-11-07 01:00:16 -080068 */
69#define RIO_DOORBELL_RESOURCE 0
70#define RIO_INB_MBOX_RESOURCE 1
71#define RIO_OUTB_MBOX_RESOURCE 2
72
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -070073#define RIO_PW_MSG_SIZE 64
74
Alexandre Bouninee6536922011-01-12 17:00:40 -080075/*
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
Matt Porter70a50eb2005-11-07 01:00:16 -080085extern struct bus_type rio_bus_type;
Alexandre Bounine2aaf3082014-04-07 15:38:56 -070086extern struct class rio_mport_class;
Matt Porter70a50eb2005-11-07 01:00:16 -080087
88struct rio_mport;
Alexandre Bounineded05782011-01-12 17:00:39 -080089struct rio_dev;
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -070090union rio_pw_msg;
Matt Porter70a50eb2005-11-07 01:00:16 -080091
92/**
Alexandre Bounineded05782011-01-12 17:00:39 -080093 * struct rio_switch - RIO switch info
94 * @node: Node in global list of switches
Alexandre Bounineded05782011-01-12 17:00:39 -080095 * @route_table: Copy of switch routing table
96 * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0
Alexandre Bounine2ec3ba62013-07-03 15:08:50 -070097 * @ops: pointer to switch-specific operations
98 * @lock: lock to serialize operations updates
Alexandre Bounineded05782011-01-12 17:00:39 -080099 * @nextdev: Array of per-port pointers to the next attached device
100 */
101struct rio_switch {
102 struct list_head node;
Alexandre Bounineded05782011-01-12 17:00:39 -0800103 u8 *route_table;
104 u32 port_ok;
Alexandre Bounine2ec3ba62013-07-03 15:08:50 -0700105 struct rio_switch_ops *ops;
106 spinlock_t lock;
107 struct rio_dev *nextdev[0];
108};
109
110/**
111 * struct rio_switch_ops - Per-switch operations
112 * @owner: The module owner of this structure
113 * @add_entry: Callback for switch-specific route add function
114 * @get_entry: Callback for switch-specific route get function
115 * @clr_table: Callback for switch-specific clear route table function
116 * @set_domain: Callback for switch-specific domain setting function
117 * @get_domain: Callback for switch-specific domain get function
118 * @em_init: Callback for switch-specific error management init function
119 * @em_handle: Callback for switch-specific error management handler function
120 *
121 * Defines the operations that are necessary to initialize/control
122 * a particular RIO switch device.
123 */
124struct rio_switch_ops {
125 struct module *owner;
Alexandre Bounineded05782011-01-12 17:00:39 -0800126 int (*add_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,
127 u16 table, u16 route_destid, u8 route_port);
128 int (*get_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,
129 u16 table, u16 route_destid, u8 *route_port);
130 int (*clr_table) (struct rio_mport *mport, u16 destid, u8 hopcount,
131 u16 table);
132 int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
133 u8 sw_domain);
134 int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
135 u8 *sw_domain);
136 int (*em_init) (struct rio_dev *dev);
137 int (*em_handle) (struct rio_dev *dev, u8 swport);
Alexandre Bounineded05782011-01-12 17:00:39 -0800138};
139
140/**
Matt Porter70a50eb2005-11-07 01:00:16 -0800141 * struct rio_dev - RIO device info
142 * @global_list: Node in list of all RIO devices
143 * @net_list: Node in list of RIO devices in a network
144 * @net: Network this device is a part of
Alexandre Bounine2ec3ba62013-07-03 15:08:50 -0700145 * @do_enum: Enumeration flag
Matt Porter70a50eb2005-11-07 01:00:16 -0800146 * @did: Device ID
147 * @vid: Vendor ID
148 * @device_rev: Device revision
149 * @asm_did: Assembly device ID
150 * @asm_vid: Assembly vendor ID
151 * @asm_rev: Assembly revision
152 * @efptr: Extended feature pointer
153 * @pef: Processing element features
154 * @swpinfo: Switch port info
155 * @src_ops: Source operation capabilities
156 * @dst_ops: Destination operation capabilities
Randy Dunlap97ef6f72010-05-28 15:08:08 -0700157 * @comp_tag: RIO component tag
158 * @phys_efptr: RIO device extended features pointer
159 * @em_efptr: RIO Error Management features pointer
Matt Porterfa78cc52005-11-07 01:00:18 -0800160 * @dma_mask: Mask of bits of RIO address this device implements
Matt Porter70a50eb2005-11-07 01:00:16 -0800161 * @driver: Driver claiming this device
162 * @dev: Device model device
163 * @riores: RIO resources this device owns
Randy Dunlap97ef6f72010-05-28 15:08:08 -0700164 * @pwcback: port-write callback function for this device
Alexandre Bouninea93192a2011-01-12 17:00:38 -0800165 * @destid: Network destination ID (or associated destid for switch)
166 * @hopcount: Hopcount to this device
Alexandre Bounine68fe4df2010-10-27 15:34:29 -0700167 * @prev: Previous RIO device connected to the current one
Alexandre Bounineded05782011-01-12 17:00:39 -0800168 * @rswitch: struct rio_switch (if valid for this device)
Matt Porter70a50eb2005-11-07 01:00:16 -0800169 */
170struct rio_dev {
171 struct list_head global_list; /* node in list of all RIO devices */
172 struct list_head net_list; /* node in per net list */
173 struct rio_net *net; /* RIO net this device resides in */
Alexandre Bounine2ec3ba62013-07-03 15:08:50 -0700174 bool do_enum;
Matt Porter70a50eb2005-11-07 01:00:16 -0800175 u16 did;
176 u16 vid;
177 u32 device_rev;
178 u16 asm_did;
179 u16 asm_vid;
180 u16 asm_rev;
181 u16 efptr;
182 u32 pef;
Alexandre Bounineae05cbd2010-10-27 15:34:29 -0700183 u32 swpinfo;
Matt Porter70a50eb2005-11-07 01:00:16 -0800184 u32 src_ops;
185 u32 dst_ops;
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700186 u32 comp_tag;
187 u32 phys_efptr;
188 u32 em_efptr;
Matt Porterfa78cc52005-11-07 01:00:18 -0800189 u64 dma_mask;
Matt Porter70a50eb2005-11-07 01:00:16 -0800190 struct rio_driver *driver; /* RIO driver claiming this device */
191 struct device dev; /* LDM device structure */
192 struct resource riores[RIO_MAX_DEV_RESOURCES];
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700193 int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
Matt Porter70a50eb2005-11-07 01:00:16 -0800194 u16 destid;
Alexandre Bouninea93192a2011-01-12 17:00:38 -0800195 u8 hopcount;
Alexandre Bounine68fe4df2010-10-27 15:34:29 -0700196 struct rio_dev *prev;
Alexandre Bounineded05782011-01-12 17:00:39 -0800197 struct rio_switch rswitch[0]; /* RIO switch info */
Matt Porter70a50eb2005-11-07 01:00:16 -0800198};
199
200#define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
201#define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
202#define to_rio_dev(n) container_of(n, struct rio_dev, dev)
Alexandre Bounineded05782011-01-12 17:00:39 -0800203#define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
Alexandre Bounine2aaf3082014-04-07 15:38:56 -0700204#define to_rio_mport(n) container_of(n, struct rio_mport, dev)
Matt Porter70a50eb2005-11-07 01:00:16 -0800205
206/**
207 * struct rio_msg - RIO message event
208 * @res: Mailbox resource
209 * @mcback: Message event callback
210 */
211struct rio_msg {
212 struct resource *res;
Matt Porter6978bbc2005-11-07 01:00:20 -0800213 void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
Matt Porter70a50eb2005-11-07 01:00:16 -0800214};
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
Matt Porter6978bbc2005-11-07 01:00:20 -0800221 * @dev_id: Device specific pointer to pass on event
Matt Porter70a50eb2005-11-07 01:00:16 -0800222 */
223struct rio_dbell {
224 struct list_head node;
225 struct resource *res;
Matt Porter6978bbc2005-11-07 01:00:20 -0800226 void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
227 void *dev_id;
Matt Porter70a50eb2005-11-07 01:00:16 -0800228};
229
Zhang Wei61b26912008-04-18 13:33:44 -0700230enum rio_phy_type {
231 RIO_PHY_PARALLEL,
232 RIO_PHY_SERIAL,
233};
234
Matt Porter70a50eb2005-11-07 01:00:16 -0800235/**
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
Randy Dunlap9941d942008-04-30 16:45:58 -0700248 * @sys_size: RapidIO common transport system size
249 * @phy_type: RapidIO phy type
Alexandre Bounineaf84ca32010-10-27 15:34:34 -0700250 * @phys_efptr: RIO port extended features pointer
Matt Porter70a50eb2005-11-07 01:00:16 -0800251 * @name: Port name string
Alexandre Bounine2aaf3082014-04-07 15:38:56 -0700252 * @dev: device structure associated with an mport
Zhang Weiad1e9382008-04-18 13:33:41 -0700253 * @priv: Master port private data
Alexandre Bouninefe50c922012-10-04 17:15:52 -0700254 * @dma: DMA device associated with mport
Alexandre Bouninea11650e2013-05-24 15:55:05 -0700255 * @nscan: RapidIO network enumeration/discovery operations
Matt Porter70a50eb2005-11-07 01:00:16 -0800256 */
257struct 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 */
Alexandre Bouninef8f06262011-03-23 16:43:02 -0700266 struct rio_ops *ops; /* low-level architecture-dependent routines */
Matt Porter70a50eb2005-11-07 01:00:16 -0800267 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 */
Zhang Weie0423232008-04-18 13:33:42 -0700270 unsigned int sys_size; /* RapidIO common transport system size.
271 * 0 - Small size. 256 devices.
272 * 1 - Large size, 65536 devices.
273 */
Zhang Wei61b26912008-04-18 13:33:44 -0700274 enum rio_phy_type phy_type; /* RapidIO phy type */
Alexandre Bounineaf84ca32010-10-27 15:34:34 -0700275 u32 phys_efptr;
Alexandre Bounineed43f442012-10-04 17:15:51 -0700276 unsigned char name[RIO_MAX_MPORT_NAME];
Alexandre Bounine2aaf3082014-04-07 15:38:56 -0700277 struct device dev;
Zhang Weiad1e9382008-04-18 13:33:41 -0700278 void *priv; /* Master port private data */
Alexandre Bouninee42d98e2012-05-31 16:26:38 -0700279#ifdef CONFIG_RAPIDIO_DMA_ENGINE
280 struct dma_device dma;
281#endif
Alexandre Bouninea11650e2013-05-24 15:55:05 -0700282 struct rio_scan *nscan;
Matt Porter70a50eb2005-11-07 01:00:16 -0800283};
284
Alexandre Bouninebc8fcfe2013-05-24 15:55:06 -0700285/*
286 * Enumeration/discovery control flags
287 */
288#define RIO_SCAN_ENUM_NO_WAIT 0x00000001 /* Do not wait for enum completed */
289
Alexandre Bouninede74e002012-10-04 17:16:13 -0700290struct rio_id_table {
291 u16 start; /* logical minimal id */
Alexandre Bouninede74e002012-10-04 17:16:13 -0700292 u32 max; /* max number of IDs in table */
293 spinlock_t lock;
294 unsigned long *table;
295};
296
Matt Porter70a50eb2005-11-07 01:00:16 -0800297/**
298 * struct rio_net - RIO network info
299 * @node: Node in global list of RIO networks
300 * @devices: List of devices in this network
Masanari Iida76679282015-05-08 00:02:27 +0900301 * @switches: List of switches in this network
Matt Porter70a50eb2005-11-07 01:00:16 -0800302 * @mports: List of master ports accessing this network
303 * @hport: Default port for accessing this network
304 * @id: RIO network ID
Randy Dunlap2ca3cb52012-11-16 14:14:56 -0800305 * @destid_table: destID allocation table
Matt Porter70a50eb2005-11-07 01:00:16 -0800306 */
307struct rio_net {
308 struct list_head node; /* node in list of networks */
309 struct list_head devices; /* list of devices in this net */
Alexandre Bouninea7071ef2012-10-04 17:16:05 -0700310 struct list_head switches; /* list of switches in this net */
Matt Porter70a50eb2005-11-07 01:00:16 -0800311 struct list_head mports; /* list of ports accessing net */
312 struct rio_mport *hport; /* primary port for accessing net */
313 unsigned char id; /* RIO network ID */
Alexandre Bouninede74e002012-10-04 17:16:13 -0700314 struct rio_id_table destid_table; /* destID allocation table */
Matt Porter70a50eb2005-11-07 01:00:16 -0800315};
316
Alexandre Bounine8b189fd2016-03-22 14:26:00 -0700317enum rio_link_speed {
318 RIO_LINK_DOWN = 0, /* SRIO Link not initialized */
319 RIO_LINK_125 = 1, /* 1.25 GBaud */
320 RIO_LINK_250 = 2, /* 2.5 GBaud */
321 RIO_LINK_312 = 3, /* 3.125 GBaud */
322 RIO_LINK_500 = 4, /* 5.0 GBaud */
323 RIO_LINK_625 = 5 /* 6.25 GBaud */
324};
325
326enum rio_link_width {
327 RIO_LINK_1X = 0,
328 RIO_LINK_1XR = 1,
329 RIO_LINK_2X = 3,
330 RIO_LINK_4X = 2,
331 RIO_LINK_8X = 4,
332 RIO_LINK_16X = 5
333};
334
335enum rio_mport_flags {
336 RIO_MPORT_DMA = (1 << 0), /* supports DMA data transfers */
337 RIO_MPORT_DMA_SG = (1 << 1), /* DMA supports HW SG mode */
338 RIO_MPORT_IBSG = (1 << 2), /* inbound mapping supports SG */
339};
340
341/**
342 * struct rio_mport_attr - RIO mport device attributes
343 * @flags: mport device capability flags
344 * @link_speed: SRIO link speed value (as defined by RapidIO specification)
345 * @link_width: SRIO link width value (as defined by RapidIO specification)
346 * @dma_max_sge: number of SG list entries that can be handled by DMA channel(s)
347 * @dma_max_size: max number of bytes in single DMA transfer (SG entry)
348 * @dma_align: alignment shift for DMA operations (as for other DMA operations)
349 */
350struct rio_mport_attr {
351 int flags;
352 int link_speed;
353 int link_width;
354
355 /* DMA capability info: valid only if RIO_MPORT_DMA flag is set */
356 int dma_max_sge;
357 int dma_max_size;
358 int dma_align;
359};
360
Matt Porter70a50eb2005-11-07 01:00:16 -0800361/* Low-level architecture-dependent routines */
362
363/**
364 * struct rio_ops - Low-level RIO configuration space operations
365 * @lcread: Callback to perform local (master port) read of config space.
366 * @lcwrite: Callback to perform local (master port) write of config space.
367 * @cread: Callback to perform network read of config space.
368 * @cwrite: Callback to perform network write of config space.
369 * @dsend: Callback to send a doorbell message.
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700370 * @pwenable: Callback to enable/disable port-write message handling.
Alexandre Bouninef8f06262011-03-23 16:43:02 -0700371 * @open_outb_mbox: Callback to initialize outbound mailbox.
372 * @close_outb_mbox: Callback to shut down outbound mailbox.
373 * @open_inb_mbox: Callback to initialize inbound mailbox.
374 * @close_inb_mbox: Callback to shut down inbound mailbox.
375 * @add_outb_message: Callback to add a message to an outbound mailbox queue.
376 * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue.
377 * @get_inb_message: Callback to get a message from an inbound mailbox queue.
Alexandre Bounineda1589f2012-10-04 17:15:57 -0700378 * @map_inb: Callback to map RapidIO address region into local memory space.
379 * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb().
Alexandre Bounine8b189fd2016-03-22 14:26:00 -0700380 * @query_mport: Callback to query mport device attributes.
Matt Porter70a50eb2005-11-07 01:00:16 -0800381 */
382struct rio_ops {
Zhang Weiad1e9382008-04-18 13:33:41 -0700383 int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
384 u32 *data);
385 int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
386 u32 data);
387 int (*cread) (struct rio_mport *mport, int index, u16 destid,
388 u8 hopcount, u32 offset, int len, u32 *data);
389 int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
390 u8 hopcount, u32 offset, int len, u32 data);
391 int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700392 int (*pwenable) (struct rio_mport *mport, int enable);
Alexandre Bouninef8f06262011-03-23 16:43:02 -0700393 int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id,
394 int mbox, int entries);
395 void (*close_outb_mbox)(struct rio_mport *mport, int mbox);
396 int (*open_inb_mbox)(struct rio_mport *mport, void *dev_id,
397 int mbox, int entries);
398 void (*close_inb_mbox)(struct rio_mport *mport, int mbox);
399 int (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev,
400 int mbox, void *buffer, size_t len);
401 int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf);
402 void *(*get_inb_message)(struct rio_mport *mport, int mbox);
Alexandre Bounineda1589f2012-10-04 17:15:57 -0700403 int (*map_inb)(struct rio_mport *mport, dma_addr_t lstart,
404 u64 rstart, u32 size, u32 flags);
405 void (*unmap_inb)(struct rio_mport *mport, dma_addr_t lstart);
Alexandre Bounine8b189fd2016-03-22 14:26:00 -0700406 int (*query_mport)(struct rio_mport *mport,
407 struct rio_mport_attr *attr);
Matt Porter70a50eb2005-11-07 01:00:16 -0800408};
409
410#define RIO_RESOURCE_MEM 0x00000100
411#define RIO_RESOURCE_DOORBELL 0x00000200
412#define RIO_RESOURCE_MAILBOX 0x00000400
413
414#define RIO_RESOURCE_CACHEABLE 0x00010000
415#define RIO_RESOURCE_PCI 0x00020000
416
417#define RIO_RESOURCE_BUSY 0x80000000
418
419/**
420 * struct rio_driver - RIO driver info
421 * @node: Node in list of drivers
422 * @name: RIO driver name
423 * @id_table: RIO device ids to be associated with this driver
424 * @probe: RIO device inserted
425 * @remove: RIO device removed
Alexandre Bounine83dc2cbc2016-03-22 14:26:05 -0700426 * @shutdown: shutdown notification callback
Matt Porter70a50eb2005-11-07 01:00:16 -0800427 * @suspend: RIO device suspended
428 * @resume: RIO device awakened
429 * @enable_wake: RIO device enable wake event
430 * @driver: LDM driver struct
431 *
432 * Provides info on a RIO device driver for insertion/removal and
433 * power management purposes.
434 */
435struct rio_driver {
436 struct list_head node;
437 char *name;
438 const struct rio_device_id *id_table;
439 int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
440 void (*remove) (struct rio_dev * dev);
Alexandre Bounine83dc2cbc2016-03-22 14:26:05 -0700441 void (*shutdown)(struct rio_dev *dev);
Matt Porter70a50eb2005-11-07 01:00:16 -0800442 int (*suspend) (struct rio_dev * dev, u32 state);
443 int (*resume) (struct rio_dev * dev);
444 int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
445 struct device_driver driver;
446};
447
448#define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
449
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700450union rio_pw_msg {
451 struct {
452 u32 comptag; /* Component Tag CSR */
453 u32 errdetect; /* Port N Error Detect CSR */
454 u32 is_port; /* Implementation specific + PortID */
455 u32 ltlerrdet; /* LTL Error Detect CSR */
456 u32 padding[12];
457 } em;
458 u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
459};
460
Alexandre Bouninee42d98e2012-05-31 16:26:38 -0700461#ifdef CONFIG_RAPIDIO_DMA_ENGINE
462
Alexandre Bouninefe50c922012-10-04 17:15:52 -0700463/*
Alexandre Bouninee42d98e2012-05-31 16:26:38 -0700464 * enum rio_write_type - RIO write transaction types used in DMA transfers
465 *
466 * Note: RapidIO specification defines write (NWRITE) and
467 * write-with-response (NWRITE_R) data transfer operations.
468 * Existing DMA controllers that service RapidIO may use one of these operations
469 * for entire data transfer or their combination with only the last data packet
470 * requires response.
471 */
472enum rio_write_type {
473 RDW_DEFAULT, /* default method used by DMA driver */
474 RDW_ALL_NWRITE, /* all packets use NWRITE */
475 RDW_ALL_NWRITE_R, /* all packets use NWRITE_R */
476 RDW_LAST_NWRITE_R, /* last packet uses NWRITE_R, others - NWRITE */
477};
478
479struct rio_dma_ext {
480 u16 destid;
481 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */
482 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */
483 enum rio_write_type wr_type; /* preferred RIO write operation type */
484};
485
486struct rio_dma_data {
487 /* Local data (as scatterlist) */
488 struct scatterlist *sg; /* I/O scatter list */
489 unsigned int sg_len; /* size of scatter list */
490 /* Remote device address (flat buffer) */
491 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */
492 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */
493 enum rio_write_type wr_type; /* preferred RIO write operation type */
494};
495
496static inline struct rio_mport *dma_to_mport(struct dma_device *ddev)
497{
498 return container_of(ddev, struct rio_mport, dma);
499}
500#endif /* CONFIG_RAPIDIO_DMA_ENGINE */
501
Alexandre Bouninea11650e2013-05-24 15:55:05 -0700502/**
503 * struct rio_scan - RIO enumeration and discovery operations
Alexandre Bounine9edbc30b2013-07-03 15:08:53 -0700504 * @owner: The module owner of this structure
Alexandre Bouninea11650e2013-05-24 15:55:05 -0700505 * @enumerate: Callback to perform RapidIO fabric enumeration.
506 * @discover: Callback to perform RapidIO fabric discovery.
507 */
508struct rio_scan {
Alexandre Bounine9edbc30b2013-07-03 15:08:53 -0700509 struct module *owner;
Alexandre Bouninebc8fcfe2013-05-24 15:55:06 -0700510 int (*enumerate)(struct rio_mport *mport, u32 flags);
511 int (*discover)(struct rio_mport *mport, u32 flags);
Alexandre Bouninea11650e2013-05-24 15:55:05 -0700512};
513
Alexandre Bounine9edbc30b2013-07-03 15:08:53 -0700514/**
515 * struct rio_scan_node - list node to register RapidIO enumeration and
516 * discovery methods with RapidIO core.
517 * @mport_id: ID of an mport (net) serviced by this enumerator
518 * @node: node in global list of registered enumerators
519 * @ops: RIO enumeration and discovery operations
520 */
521struct rio_scan_node {
522 int mport_id;
523 struct list_head node;
524 struct rio_scan *ops;
525};
526
Matt Porter70a50eb2005-11-07 01:00:16 -0800527/* Architecture and hardware-specific functions */
Alexandre Bounine59f99962011-04-14 15:22:14 -0700528extern int rio_register_mport(struct rio_mport *);
Matt Porter6978bbc2005-11-07 01:00:20 -0800529extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
Matt Porter70a50eb2005-11-07 01:00:16 -0800530extern void rio_close_inb_mbox(struct rio_mport *, int);
Matt Porter6978bbc2005-11-07 01:00:20 -0800531extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
Matt Porter70a50eb2005-11-07 01:00:16 -0800532extern void rio_close_outb_mbox(struct rio_mport *, int);
Alexandre Bounine8b189fd2016-03-22 14:26:00 -0700533extern int rio_query_mport(struct rio_mport *port,
534 struct rio_mport_attr *mport_attr);
Matt Porter70a50eb2005-11-07 01:00:16 -0800535
Matt Porter70a50eb2005-11-07 01:00:16 -0800536#endif /* LINUX_RIO_H */