stable: update documentation to ask for kernel version
[linux/fpc-iii.git] / Documentation / rapidio / tsi721.txt
blob335f3c6087dcb35d5285bed3d766bba8f9bc4470
1 RapidIO subsystem mport driver for IDT Tsi721 PCI Express-to-SRIO bridge.
2 =========================================================================
4 I. Overview
6 This driver implements all currently defined RapidIO mport callback functions.
7 It supports maintenance read and write operations, inbound and outbound RapidIO
8 doorbells, inbound maintenance port-writes and RapidIO messaging.
10 To generate SRIO maintenance transactions this driver uses one of Tsi721 DMA
11 channels. This mechanism provides access to larger range of hop counts and
12 destination IDs without need for changes in outbound window translation.
14 RapidIO messaging support uses dedicated messaging channels for each mailbox.
15 For inbound messages this driver uses destination ID matching to forward messages
16 into the corresponding message queue. Messaging callbacks are implemented to be
17 fully compatible with RIONET driver (Ethernet over RapidIO messaging services).
19 II. Known problems
21   None.
23 III. To do
25  Add DMA data transfers (non-messaging).
26  Add inbound region (SRIO-to-PCIe) mapping.
28 IV. Version History
30   1.0.0 - Initial driver release.
32 V.  License
33 -----------------------------------------------
35   Copyright(c) 2011 Integrated Device Technology, Inc. All rights reserved.
37   This program is free software; you can redistribute it and/or modify it
38   under the terms of the GNU General Public License as published by the Free
39   Software Foundation; either version 2 of the License, or (at your option)
40   any later version.
42   This program is distributed in the hope that it will be useful, but WITHOUT
43   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
44   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
45   more details.
47   You should have received a copy of the GNU General Public License along with
48   this program; if not, write to the Free Software Foundation, Inc.,
49   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.