About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / misc-devices / spear-pcie-gadget.txt




Custom Search

Based on kernel version 3.9. Page generated on 2013-05-02 23:10 EST.

1	Spear PCIe Gadget Driver:
2	
3	Author
4	=============
5	Pratyush Anand (pratyush.anand@st.com)
6	
7	Location
8	============
9	driver/misc/spear13xx_pcie_gadget.c
10	
11	Supported Chip:
12	===================
13	SPEAr1300
14	SPEAr1310
15	
16	Menuconfig option:
17	==========================
18	Device Drivers
19		Misc devices
20			PCIe gadget support for SPEAr13XX platform
21	purpose
22	===========
23	This driver has several nodes which can be read/written by configfs interface.
24	Its main purpose is to configure selected dual mode PCIe controller as device
25	and then program its various registers to configure it as a particular device
26	type. This driver can be used to show spear's PCIe device capability.
27	
28	Description of different nodes:
29	=================================
30	
31	read behavior of nodes:
32	------------------------------
33	link 		:gives ltssm status.
34	int_type 	:type of supported interrupt
35	no_of_msi 	:zero if MSI is not enabled by host. A positive value is the
36			number of MSI vector granted.
37	vendor_id	:returns programmed vendor id (hex)
38	device_id	:returns programmed device id(hex)
39	bar0_size:	:returns size of bar0 in hex.
40	bar0_address	:returns address of bar0 mapped area in hex.
41	bar0_rw_offset	:returns offset of bar0 for which bar0_data will return value.
42	bar0_data	:returns data at bar0_rw_offset.
43	
44	write behavior of nodes:
45	------------------------------
46	link 		:write UP to enable ltsmm DOWN to disable
47	int_type	:write interrupt type to be configured and (int_type could be
48			INTA, MSI or NO_INT). Select MSI only when you have programmed
49			no_of_msi node.
50	no_of_msi	:number of MSI vector needed.
51	inta		:write 1 to assert INTA and 0 to de-assert.
52	send_msi	:write MSI vector to be sent.
53	vendor_id	:write vendor id(hex) to be programmed.
54	device_id	:write device id(hex) to be programmed.
55	bar0_size	:write size of bar0 in hex. default bar0 size is 1000 (hex)
56			bytes.
57	bar0_address	:write	address of bar0 mapped area in hex. (default mapping of
58			bar0 is SYSRAM1(E0800000). Always program bar size before bar
59			address. Kernel might modify bar size and address for alignment, so
60			read back bar size and address after writing to cross check.
61	bar0_rw_offset	:write offset of bar0 for which	bar0_data will write value.
62	bar0_data	:write data to be written at bar0_rw_offset.
63	
64	Node programming example
65	===========================
66	Program all PCIe registers in such a way that when this device is connected
67	to the PCIe host, then host sees this device as 1MB RAM.
68	#mount -t configfs none /Config
69	For nth PCIe Device Controller
70	# cd /config/pcie_gadget.n/
71	Now you have all the nodes in this directory.
72	program vendor id as 0x104a
73	# echo 104A >> vendor_id
74	
75	program device id as 0xCD80
76	# echo CD80 >> device_id
77	
78	program BAR0 size as 1MB
79	# echo 100000 >> bar0_size
80	
81	check for programmed bar0 size
82	# cat bar0_size
83	
84	Program BAR0 Address as DDR (0x2100000). This is the physical address of
85	memory, which is to be made visible to PCIe host. Similarly any other peripheral
86	can also be made visible to PCIe host. E.g., if you program base address of UART
87	as BAR0 address then when this device will be connected to a host, it will be
88	visible as UART.
89	# echo 2100000 >> bar0_address
90	
91	program interrupt type : INTA
92	# echo INTA >> int_type
93	
94	go for link up now.
95	# echo UP >> link
96	
97	It will have to be insured that, once link up is done on gadget, then only host
98	is initialized and start to search PCIe devices on its port.
99	
100	/*wait till link is up*/
101	# cat link
102	wait till it returns UP.
103	
104	To assert INTA
105	# echo 1 >> inta
106	
107	To de-assert INTA
108	# echo 0 >> inta
109	
110	if MSI is to be used as interrupt, program no of msi vector needed (say4)
111	# echo 4 >> no_of_msi
112	
113	select MSI as interrupt type
114	# echo MSI >> int_type
115	
116	go for link up now
117	# echo UP >> link
118	
119	wait till link is up
120	# cat link
121	An application can repetitively read this node till link is found UP. It can
122	sleep between two read.
123	
124	wait till msi is enabled
125	# cat no_of_msi
126	Should return 4 (number of requested MSI vector)
127	
128	to send msi vector 2
129	# echo 2 >> send_msi
130	#cd -
Hide Line Numbers
About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog
Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.