1 ==============================================
2 RapidIO subsystem mport driver for IDT Tsi721
3 ==============================================
4
5 1. Overview
6 ===========
7
8 This driver implements all currently defined R
9 It supports maintenance read and write operati
10 doorbells, inbound maintenance port-writes and
11
12 To generate SRIO maintenance transactions this
13 channels. This mechanism provides access to la
14 destination IDs without need for changes in ou
15
16 RapidIO messaging support uses dedicated messa
17 For inbound messages this driver uses destinat
18 into the corresponding message queue. Messagin
19 fully compatible with RIONET driver (Ethernet
20
21 1. Module parameters:
22
23 - 'dbg_level'
24 - This parameter allows to control amoun
25 generated by this device driver. This
26 This parameter can be changed bit mask
27 functional block.
28 For mask definitions see 'drivers/rapi
29 This parameter can be changed dynamica
30 Use CONFIG_RAPIDIO_DEBUG=y to enable d
31
32 - 'dma_desc_per_channel'
33 - This parameter defines number of hardw
34 descriptors allocated for each registe
35 Its default value is 128.
36
37 - 'dma_txqueue_sz'
38 - DMA transactions queue size. Defines n
39 transaction requests that can be accep
40 Default value is 16.
41
42 - 'dma_sel'
43 - DMA channel selection mask. Bitmask th
44 DMA channels (0 ... 6) will be registe
45 If bit is set to 1, the corresponding
46 DMA channels not selected by this mask
47 driver. Default value is 0x7f (use all
48
49 - 'pcie_mrrs'
50 - override value for PCIe Maximum Read R
51 This parameter gives an ability to ove
52 configuration process. Tsi721 supports
53 Value for this parameter must be set a
54 0 = 128B, 1 = 256B, 2 = 512B, 3 = 1024
55 Default value is '-1' (= keep platform
56
57 - 'mbox_sel'
58 - RIO messaging MBOX selection mask. Thi
59 messaging MBOXes are managed by this d
60 correspond to MBOX0 - MBOX3. MBOX is u
61 corresponding bit is set to '1'. Defau
62
63 2. Known problems
64 =================
65
66 None.
67
68 3. DMA Engine Support
69 =====================
70
71 Tsi721 mport driver supports DMA data transfer
72 remote RapidIO devices. This functionality is
73 mode API defined by common Linux kernel DMA En
74
75 Depending on system requirements RapidIO DMA o
76 by setting CONFIG_RAPIDIO_DMA_ENGINE option. T
77 out of eight available BDMA channels to suppor
78 One BDMA channel is reserved for generation of
79
80 If Tsi721 mport driver have been built with RA
81 this driver will accept DMA-specific module pa
82
83 "dma_desc_per_channel"
84 - defines number of h
85 each BDMA channel o
86
87 4. Version History
88
89 ===== ====================================
90 1.1.0 DMA operations re-worked to support
91 than hardware buffer descriptors rin
92 1.0.0 Initial driver release.
93 ===== ====================================
94
95 5. License
96 ===========
97
98 Copyright(c) 2011 Integrated Device Technolo
99
100 This program is free software; you can redis
101 under the terms of the GNU General Public Li
102 Software Foundation; either version 2 of the
103 any later version.
104
105 This program is distributed in the hope that
106 ANY WARRANTY; without even the implied warra
107 FITNESS FOR A PARTICULAR PURPOSE. See the G
108 more details.
109
110 You should have received a copy of the GNU G
111 this program; if not, write to the Free Soft
112 59 Temple Place - Suite 330, Boston, MA 021
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.