blob: aa2323893e8d68b8156fa6b9422ac12b20dc96a6 [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
Alexandre Bounineb77a2032016-03-22 14:26:20 -0700140enum rio_device_state {
141 RIO_DEVICE_INITIALIZING,
142 RIO_DEVICE_RUNNING,
143 RIO_DEVICE_GONE,
144 RIO_DEVICE_SHUTDOWN,
145};
146
Alexandre Bounineded05782011-01-12 17:00:39 -0800147/**
Matt Porter70a50eb2005-11-07 01:00:16 -0800148 * struct rio_dev - RIO device info
149 * @global_list: Node in list of all RIO devices
150 * @net_list: Node in list of RIO devices in a network
151 * @net: Network this device is a part of
Alexandre Bounine2ec3ba62013-07-03 15:08:50 -0700152 * @do_enum: Enumeration flag
Matt Porter70a50eb2005-11-07 01:00:16 -0800153 * @did: Device ID
154 * @vid: Vendor ID
155 * @device_rev: Device revision
156 * @asm_did: Assembly device ID
157 * @asm_vid: Assembly vendor ID
158 * @asm_rev: Assembly revision
159 * @efptr: Extended feature pointer
160 * @pef: Processing element features
161 * @swpinfo: Switch port info
162 * @src_ops: Source operation capabilities
163 * @dst_ops: Destination operation capabilities
Randy Dunlap97ef6f72010-05-28 15:08:08 -0700164 * @comp_tag: RIO component tag
165 * @phys_efptr: RIO device extended features pointer
166 * @em_efptr: RIO Error Management features pointer
Matt Porterfa78cc52005-11-07 01:00:18 -0800167 * @dma_mask: Mask of bits of RIO address this device implements
Matt Porter70a50eb2005-11-07 01:00:16 -0800168 * @driver: Driver claiming this device
169 * @dev: Device model device
170 * @riores: RIO resources this device owns
Randy Dunlap97ef6f72010-05-28 15:08:08 -0700171 * @pwcback: port-write callback function for this device
Alexandre Bouninea93192a2011-01-12 17:00:38 -0800172 * @destid: Network destination ID (or associated destid for switch)
173 * @hopcount: Hopcount to this device
Alexandre Bounine68fe4df2010-10-27 15:34:29 -0700174 * @prev: Previous RIO device connected to the current one
Alexandre Bounineb77a2032016-03-22 14:26:20 -0700175 * @state: device state
Alexandre Bounineded05782011-01-12 17:00:39 -0800176 * @rswitch: struct rio_switch (if valid for this device)
Matt Porter70a50eb2005-11-07 01:00:16 -0800177 */
178struct rio_dev {
179 struct list_head global_list; /* node in list of all RIO devices */
180 struct list_head net_list; /* node in per net list */
181 struct rio_net *net; /* RIO net this device resides in */
Alexandre Bounine2ec3ba62013-07-03 15:08:50 -0700182 bool do_enum;
Matt Porter70a50eb2005-11-07 01:00:16 -0800183 u16 did;
184 u16 vid;
185 u32 device_rev;
186 u16 asm_did;
187 u16 asm_vid;
188 u16 asm_rev;
189 u16 efptr;
190 u32 pef;
Alexandre Bounineae05cbd2010-10-27 15:34:29 -0700191 u32 swpinfo;
Matt Porter70a50eb2005-11-07 01:00:16 -0800192 u32 src_ops;
193 u32 dst_ops;
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700194 u32 comp_tag;
195 u32 phys_efptr;
196 u32 em_efptr;
Matt Porterfa78cc52005-11-07 01:00:18 -0800197 u64 dma_mask;
Matt Porter70a50eb2005-11-07 01:00:16 -0800198 struct rio_driver *driver; /* RIO driver claiming this device */
199 struct device dev; /* LDM device structure */
200 struct resource riores[RIO_MAX_DEV_RESOURCES];
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700201 int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
Matt Porter70a50eb2005-11-07 01:00:16 -0800202 u16 destid;
Alexandre Bouninea93192a2011-01-12 17:00:38 -0800203 u8 hopcount;
Alexandre Bounine68fe4df2010-10-27 15:34:29 -0700204 struct rio_dev *prev;
Alexandre Bounineb77a2032016-03-22 14:26:20 -0700205 atomic_t state;
Alexandre Bounineded05782011-01-12 17:00:39 -0800206 struct rio_switch rswitch[0]; /* RIO switch info */
Matt Porter70a50eb2005-11-07 01:00:16 -0800207};
208
209#define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
210#define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
211#define to_rio_dev(n) container_of(n, struct rio_dev, dev)
Alexandre Bounineded05782011-01-12 17:00:39 -0800212#define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
Alexandre Bounine2aaf3082014-04-07 15:38:56 -0700213#define to_rio_mport(n) container_of(n, struct rio_mport, dev)
Alexandre Bouninee6b585c2016-03-22 14:26:17 -0700214#define to_rio_net(n) container_of(n, struct rio_net, dev)
Matt Porter70a50eb2005-11-07 01:00:16 -0800215
216/**
217 * struct rio_msg - RIO message event
218 * @res: Mailbox resource
219 * @mcback: Message event callback
220 */
221struct rio_msg {
222 struct resource *res;
Matt Porter6978bbc2005-11-07 01:00:20 -0800223 void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
Matt Porter70a50eb2005-11-07 01:00:16 -0800224};
225
226/**
227 * struct rio_dbell - RIO doorbell event
228 * @node: Node in list of doorbell events
229 * @res: Doorbell resource
230 * @dinb: Doorbell event callback
Matt Porter6978bbc2005-11-07 01:00:20 -0800231 * @dev_id: Device specific pointer to pass on event
Matt Porter70a50eb2005-11-07 01:00:16 -0800232 */
233struct rio_dbell {
234 struct list_head node;
235 struct resource *res;
Matt Porter6978bbc2005-11-07 01:00:20 -0800236 void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
237 void *dev_id;
Matt Porter70a50eb2005-11-07 01:00:16 -0800238};
239
Zhang Wei61b26912008-04-18 13:33:44 -0700240enum rio_phy_type {
241 RIO_PHY_PARALLEL,
242 RIO_PHY_SERIAL,
243};
244
Matt Porter70a50eb2005-11-07 01:00:16 -0800245/**
246 * struct rio_mport - RIO master port info
247 * @dbells: List of doorbell events
Alexandre Bounine9a0b0622016-03-22 14:26:44 -0700248 * @pwrites: List of portwrite events
Matt Porter70a50eb2005-11-07 01:00:16 -0800249 * @node: Node in global list of master ports
250 * @nnode: Node in network list of master ports
Alexandre Bouninee6b585c2016-03-22 14:26:17 -0700251 * @net: RIO net this mport is attached to
Alexandre Bouninea7b4c632016-03-22 14:26:35 -0700252 * @lock: lock to synchronize lists manipulations
Matt Porter70a50eb2005-11-07 01:00:16 -0800253 * @iores: I/O mem resource that this master port interface owns
254 * @riores: RIO resources that this master port interfaces owns
255 * @inb_msg: RIO inbound message event descriptors
256 * @outb_msg: RIO outbound message event descriptors
257 * @host_deviceid: Host device ID associated with this master port
258 * @ops: configuration space functions
259 * @id: Port ID, unique among all ports
260 * @index: Port index, unique among all port interfaces of the same type
Randy Dunlap9941d942008-04-30 16:45:58 -0700261 * @sys_size: RapidIO common transport system size
262 * @phy_type: RapidIO phy type
Alexandre Bounineaf84ca32010-10-27 15:34:34 -0700263 * @phys_efptr: RIO port extended features pointer
Matt Porter70a50eb2005-11-07 01:00:16 -0800264 * @name: Port name string
Alexandre Bounine2aaf3082014-04-07 15:38:56 -0700265 * @dev: device structure associated with an mport
Zhang Weiad1e9382008-04-18 13:33:41 -0700266 * @priv: Master port private data
Alexandre Bouninefe50c922012-10-04 17:15:52 -0700267 * @dma: DMA device associated with mport
Alexandre Bouninea11650e2013-05-24 15:55:05 -0700268 * @nscan: RapidIO network enumeration/discovery operations
Alexandre Bounineb77a2032016-03-22 14:26:20 -0700269 * @state: mport device state
Alexandre Bounineb6cb95e2016-03-22 14:26:41 -0700270 * @pwe_refcnt: port-write enable ref counter to track enable/disable requests
Matt Porter70a50eb2005-11-07 01:00:16 -0800271 */
272struct rio_mport {
273 struct list_head dbells; /* list of doorbell events */
Alexandre Bounine9a0b0622016-03-22 14:26:44 -0700274 struct list_head pwrites; /* list of portwrite events */
Matt Porter70a50eb2005-11-07 01:00:16 -0800275 struct list_head node; /* node in global list of ports */
276 struct list_head nnode; /* node in net list of ports */
Alexandre Bouninee6b585c2016-03-22 14:26:17 -0700277 struct rio_net *net; /* RIO net this mport is attached to */
Alexandre Bouninea7b4c632016-03-22 14:26:35 -0700278 struct mutex lock;
Matt Porter70a50eb2005-11-07 01:00:16 -0800279 struct resource iores;
280 struct resource riores[RIO_MAX_MPORT_RESOURCES];
281 struct rio_msg inb_msg[RIO_MAX_MBOX];
282 struct rio_msg outb_msg[RIO_MAX_MBOX];
283 int host_deviceid; /* Host device ID */
Alexandre Bouninef8f06262011-03-23 16:43:02 -0700284 struct rio_ops *ops; /* low-level architecture-dependent routines */
Matt Porter70a50eb2005-11-07 01:00:16 -0800285 unsigned char id; /* port ID, unique among all ports */
286 unsigned char index; /* port index, unique among all port
287 interfaces of the same type */
Zhang Weie0423232008-04-18 13:33:42 -0700288 unsigned int sys_size; /* RapidIO common transport system size.
289 * 0 - Small size. 256 devices.
290 * 1 - Large size, 65536 devices.
291 */
Zhang Wei61b26912008-04-18 13:33:44 -0700292 enum rio_phy_type phy_type; /* RapidIO phy type */
Alexandre Bounineaf84ca32010-10-27 15:34:34 -0700293 u32 phys_efptr;
Alexandre Bounineed43f442012-10-04 17:15:51 -0700294 unsigned char name[RIO_MAX_MPORT_NAME];
Alexandre Bounine2aaf3082014-04-07 15:38:56 -0700295 struct device dev;
Zhang Weiad1e9382008-04-18 13:33:41 -0700296 void *priv; /* Master port private data */
Alexandre Bouninee42d98e2012-05-31 16:26:38 -0700297#ifdef CONFIG_RAPIDIO_DMA_ENGINE
298 struct dma_device dma;
299#endif
Alexandre Bouninea11650e2013-05-24 15:55:05 -0700300 struct rio_scan *nscan;
Alexandre Bounineb77a2032016-03-22 14:26:20 -0700301 atomic_t state;
Alexandre Bounineb6cb95e2016-03-22 14:26:41 -0700302 unsigned int pwe_refcnt;
Matt Porter70a50eb2005-11-07 01:00:16 -0800303};
304
Alexandre Bounineb77a2032016-03-22 14:26:20 -0700305static inline int rio_mport_is_running(struct rio_mport *mport)
306{
307 return atomic_read(&mport->state) == RIO_DEVICE_RUNNING;
308}
309
Alexandre Bouninebc8fcfe2013-05-24 15:55:06 -0700310/*
311 * Enumeration/discovery control flags
312 */
313#define RIO_SCAN_ENUM_NO_WAIT 0x00000001 /* Do not wait for enum completed */
314
Matt Porter70a50eb2005-11-07 01:00:16 -0800315/**
316 * struct rio_net - RIO network info
317 * @node: Node in global list of RIO networks
318 * @devices: List of devices in this network
Masanari Iida76679282015-05-08 00:02:27 +0900319 * @switches: List of switches in this network
Matt Porter70a50eb2005-11-07 01:00:16 -0800320 * @mports: List of master ports accessing this network
321 * @hport: Default port for accessing this network
322 * @id: RIO network ID
Alexandre Bouninee6b585c2016-03-22 14:26:17 -0700323 * @dev: Device object
324 * @enum_data: private data specific to a network enumerator
325 * @release: enumerator-specific release callback
Matt Porter70a50eb2005-11-07 01:00:16 -0800326 */
327struct rio_net {
328 struct list_head node; /* node in list of networks */
329 struct list_head devices; /* list of devices in this net */
Alexandre Bouninea7071ef2012-10-04 17:16:05 -0700330 struct list_head switches; /* list of switches in this net */
Matt Porter70a50eb2005-11-07 01:00:16 -0800331 struct list_head mports; /* list of ports accessing net */
332 struct rio_mport *hport; /* primary port for accessing net */
333 unsigned char id; /* RIO network ID */
Alexandre Bouninee6b585c2016-03-22 14:26:17 -0700334 struct device dev;
335 void *enum_data; /* private data for enumerator of the network */
336 void (*release)(struct rio_net *net);
Matt Porter70a50eb2005-11-07 01:00:16 -0800337};
338
Alexandre Bounine8b189fd2016-03-22 14:26:00 -0700339enum rio_link_speed {
340 RIO_LINK_DOWN = 0, /* SRIO Link not initialized */
341 RIO_LINK_125 = 1, /* 1.25 GBaud */
342 RIO_LINK_250 = 2, /* 2.5 GBaud */
343 RIO_LINK_312 = 3, /* 3.125 GBaud */
344 RIO_LINK_500 = 4, /* 5.0 GBaud */
345 RIO_LINK_625 = 5 /* 6.25 GBaud */
346};
347
348enum rio_link_width {
349 RIO_LINK_1X = 0,
350 RIO_LINK_1XR = 1,
351 RIO_LINK_2X = 3,
352 RIO_LINK_4X = 2,
353 RIO_LINK_8X = 4,
354 RIO_LINK_16X = 5
355};
356
357enum rio_mport_flags {
358 RIO_MPORT_DMA = (1 << 0), /* supports DMA data transfers */
359 RIO_MPORT_DMA_SG = (1 << 1), /* DMA supports HW SG mode */
360 RIO_MPORT_IBSG = (1 << 2), /* inbound mapping supports SG */
361};
362
363/**
364 * struct rio_mport_attr - RIO mport device attributes
365 * @flags: mport device capability flags
366 * @link_speed: SRIO link speed value (as defined by RapidIO specification)
367 * @link_width: SRIO link width value (as defined by RapidIO specification)
368 * @dma_max_sge: number of SG list entries that can be handled by DMA channel(s)
369 * @dma_max_size: max number of bytes in single DMA transfer (SG entry)
370 * @dma_align: alignment shift for DMA operations (as for other DMA operations)
371 */
372struct rio_mport_attr {
373 int flags;
374 int link_speed;
375 int link_width;
376
377 /* DMA capability info: valid only if RIO_MPORT_DMA flag is set */
378 int dma_max_sge;
379 int dma_max_size;
380 int dma_align;
381};
382
Matt Porter70a50eb2005-11-07 01:00:16 -0800383/* Low-level architecture-dependent routines */
384
385/**
386 * struct rio_ops - Low-level RIO configuration space operations
387 * @lcread: Callback to perform local (master port) read of config space.
388 * @lcwrite: Callback to perform local (master port) write of config space.
389 * @cread: Callback to perform network read of config space.
390 * @cwrite: Callback to perform network write of config space.
391 * @dsend: Callback to send a doorbell message.
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700392 * @pwenable: Callback to enable/disable port-write message handling.
Alexandre Bouninef8f06262011-03-23 16:43:02 -0700393 * @open_outb_mbox: Callback to initialize outbound mailbox.
394 * @close_outb_mbox: Callback to shut down outbound mailbox.
395 * @open_inb_mbox: Callback to initialize inbound mailbox.
396 * @close_inb_mbox: Callback to shut down inbound mailbox.
397 * @add_outb_message: Callback to add a message to an outbound mailbox queue.
398 * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue.
399 * @get_inb_message: Callback to get a message from an inbound mailbox queue.
Alexandre Bounineda1589f2012-10-04 17:15:57 -0700400 * @map_inb: Callback to map RapidIO address region into local memory space.
401 * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb().
Alexandre Bounine8b189fd2016-03-22 14:26:00 -0700402 * @query_mport: Callback to query mport device attributes.
Alexandre Bounine93bdaca2016-03-22 14:26:50 -0700403 * @map_outb: Callback to map outbound address region into local memory space.
404 * @unmap_outb: Callback to unmap outbound RapidIO address region.
Matt Porter70a50eb2005-11-07 01:00:16 -0800405 */
406struct rio_ops {
Zhang Weiad1e9382008-04-18 13:33:41 -0700407 int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
408 u32 *data);
409 int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
410 u32 data);
411 int (*cread) (struct rio_mport *mport, int index, u16 destid,
412 u8 hopcount, u32 offset, int len, u32 *data);
413 int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
414 u8 hopcount, u32 offset, int len, u32 data);
415 int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700416 int (*pwenable) (struct rio_mport *mport, int enable);
Alexandre Bouninef8f06262011-03-23 16:43:02 -0700417 int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id,
418 int mbox, int entries);
419 void (*close_outb_mbox)(struct rio_mport *mport, int mbox);
420 int (*open_inb_mbox)(struct rio_mport *mport, void *dev_id,
421 int mbox, int entries);
422 void (*close_inb_mbox)(struct rio_mport *mport, int mbox);
423 int (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev,
424 int mbox, void *buffer, size_t len);
425 int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf);
426 void *(*get_inb_message)(struct rio_mport *mport, int mbox);
Alexandre Bounineda1589f2012-10-04 17:15:57 -0700427 int (*map_inb)(struct rio_mport *mport, dma_addr_t lstart,
428 u64 rstart, u32 size, u32 flags);
429 void (*unmap_inb)(struct rio_mport *mport, dma_addr_t lstart);
Alexandre Bounine8b189fd2016-03-22 14:26:00 -0700430 int (*query_mport)(struct rio_mport *mport,
431 struct rio_mport_attr *attr);
Alexandre Bounine93bdaca2016-03-22 14:26:50 -0700432 int (*map_outb)(struct rio_mport *mport, u16 destid, u64 rstart,
433 u32 size, u32 flags, dma_addr_t *laddr);
434 void (*unmap_outb)(struct rio_mport *mport, u16 destid, u64 rstart);
Matt Porter70a50eb2005-11-07 01:00:16 -0800435};
436
437#define RIO_RESOURCE_MEM 0x00000100
438#define RIO_RESOURCE_DOORBELL 0x00000200
439#define RIO_RESOURCE_MAILBOX 0x00000400
440
441#define RIO_RESOURCE_CACHEABLE 0x00010000
442#define RIO_RESOURCE_PCI 0x00020000
443
444#define RIO_RESOURCE_BUSY 0x80000000
445
446/**
447 * struct rio_driver - RIO driver info
448 * @node: Node in list of drivers
449 * @name: RIO driver name
450 * @id_table: RIO device ids to be associated with this driver
451 * @probe: RIO device inserted
452 * @remove: RIO device removed
Alexandre Bounine83dc2cbc2016-03-22 14:26:05 -0700453 * @shutdown: shutdown notification callback
Matt Porter70a50eb2005-11-07 01:00:16 -0800454 * @suspend: RIO device suspended
455 * @resume: RIO device awakened
456 * @enable_wake: RIO device enable wake event
457 * @driver: LDM driver struct
458 *
459 * Provides info on a RIO device driver for insertion/removal and
460 * power management purposes.
461 */
462struct rio_driver {
463 struct list_head node;
464 char *name;
465 const struct rio_device_id *id_table;
466 int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
467 void (*remove) (struct rio_dev * dev);
Alexandre Bounine83dc2cbc2016-03-22 14:26:05 -0700468 void (*shutdown)(struct rio_dev *dev);
Matt Porter70a50eb2005-11-07 01:00:16 -0800469 int (*suspend) (struct rio_dev * dev, u32 state);
470 int (*resume) (struct rio_dev * dev);
471 int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
472 struct device_driver driver;
473};
474
475#define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
476
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700477union rio_pw_msg {
478 struct {
479 u32 comptag; /* Component Tag CSR */
480 u32 errdetect; /* Port N Error Detect CSR */
481 u32 is_port; /* Implementation specific + PortID */
482 u32 ltlerrdet; /* LTL Error Detect CSR */
483 u32 padding[12];
484 } em;
485 u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
486};
487
Alexandre Bouninee42d98e2012-05-31 16:26:38 -0700488#ifdef CONFIG_RAPIDIO_DMA_ENGINE
489
Alexandre Bouninefe50c922012-10-04 17:15:52 -0700490/*
Alexandre Bouninee42d98e2012-05-31 16:26:38 -0700491 * enum rio_write_type - RIO write transaction types used in DMA transfers
492 *
493 * Note: RapidIO specification defines write (NWRITE) and
494 * write-with-response (NWRITE_R) data transfer operations.
495 * Existing DMA controllers that service RapidIO may use one of these operations
496 * for entire data transfer or their combination with only the last data packet
497 * requires response.
498 */
499enum rio_write_type {
500 RDW_DEFAULT, /* default method used by DMA driver */
501 RDW_ALL_NWRITE, /* all packets use NWRITE */
502 RDW_ALL_NWRITE_R, /* all packets use NWRITE_R */
503 RDW_LAST_NWRITE_R, /* last packet uses NWRITE_R, others - NWRITE */
504};
505
506struct rio_dma_ext {
507 u16 destid;
508 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */
509 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */
510 enum rio_write_type wr_type; /* preferred RIO write operation type */
511};
512
513struct rio_dma_data {
514 /* Local data (as scatterlist) */
515 struct scatterlist *sg; /* I/O scatter list */
516 unsigned int sg_len; /* size of scatter list */
517 /* Remote device address (flat buffer) */
518 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */
519 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */
520 enum rio_write_type wr_type; /* preferred RIO write operation type */
521};
522
523static inline struct rio_mport *dma_to_mport(struct dma_device *ddev)
524{
525 return container_of(ddev, struct rio_mport, dma);
526}
527#endif /* CONFIG_RAPIDIO_DMA_ENGINE */
528
Alexandre Bouninea11650e2013-05-24 15:55:05 -0700529/**
530 * struct rio_scan - RIO enumeration and discovery operations
Alexandre Bounine9edbc30b2013-07-03 15:08:53 -0700531 * @owner: The module owner of this structure
Alexandre Bouninea11650e2013-05-24 15:55:05 -0700532 * @enumerate: Callback to perform RapidIO fabric enumeration.
533 * @discover: Callback to perform RapidIO fabric discovery.
534 */
535struct rio_scan {
Alexandre Bounine9edbc30b2013-07-03 15:08:53 -0700536 struct module *owner;
Alexandre Bouninebc8fcfe2013-05-24 15:55:06 -0700537 int (*enumerate)(struct rio_mport *mport, u32 flags);
538 int (*discover)(struct rio_mport *mport, u32 flags);
Alexandre Bouninea11650e2013-05-24 15:55:05 -0700539};
540
Alexandre Bounine9edbc30b2013-07-03 15:08:53 -0700541/**
542 * struct rio_scan_node - list node to register RapidIO enumeration and
543 * discovery methods with RapidIO core.
544 * @mport_id: ID of an mport (net) serviced by this enumerator
545 * @node: node in global list of registered enumerators
546 * @ops: RIO enumeration and discovery operations
547 */
548struct rio_scan_node {
549 int mport_id;
550 struct list_head node;
551 struct rio_scan *ops;
552};
553
Matt Porter70a50eb2005-11-07 01:00:16 -0800554/* Architecture and hardware-specific functions */
Alexandre Bounineb77a2032016-03-22 14:26:20 -0700555extern int rio_mport_initialize(struct rio_mport *);
Alexandre Bounine59f99962011-04-14 15:22:14 -0700556extern int rio_register_mport(struct rio_mport *);
Alexandre Bounineb77a2032016-03-22 14:26:20 -0700557extern int rio_unregister_mport(struct rio_mport *);
Matt Porter6978bbc2005-11-07 01:00:20 -0800558extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
Matt Porter70a50eb2005-11-07 01:00:16 -0800559extern void rio_close_inb_mbox(struct rio_mport *, int);
Matt Porter6978bbc2005-11-07 01:00:20 -0800560extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
Matt Porter70a50eb2005-11-07 01:00:16 -0800561extern void rio_close_outb_mbox(struct rio_mport *, int);
Alexandre Bounine8b189fd2016-03-22 14:26:00 -0700562extern int rio_query_mport(struct rio_mport *port,
563 struct rio_mport_attr *mport_attr);
Matt Porter70a50eb2005-11-07 01:00:16 -0800564
Matt Porter70a50eb2005-11-07 01:00:16 -0800565#endif /* LINUX_RIO_H */