Skip to content

Commit 07f2385

Browse files
n1000n1000
committed
Fix tables in drivers section of documentation
1 parent 21085f1 commit 07f2385

File tree

1 file changed

+67
-166
lines changed

1 file changed

+67
-166
lines changed

‎docs/drivers.rst

+67-166
Original file line numberDiff line numberDiff line change
@@ -24,85 +24,38 @@ SPI Transmit Frame
2424

2525
Allocate a 1528-byte buffer to accommodate the largest outgoing serial packet and pad with ``NUL`` bytes. Write ``SOF``, compute and write ``FL``, copy the outgoing frame then write ``EOF``. Serially transmit ``FL`` + ``12`` buffer bytes to the QCA7000.
2626

27-
Offset
28-
29-
Length
30-
31-
Symbol
32-
33-
Description
34-
35-
0x0000
36-
37-
4
38-
39-
SOF
40-
41-
Start Of Frame. Must be ``0xAAAAAAAA``.
42-
43-
0x0004
44-
45-
2
46-
47-
FL
48-
49-
The Ethernet frame length in little endian format. The frame starts at offset ``0x0008`` here and includes all fields up to but excluding ``EOF``. The minimum is ``60``. The maximum is ``1518`` if ``VLAN`` is omitted and ``1522`` if not.
50-
51-
0x0006
52-
53-
2
54-
55-
RSVD
56-
57-
Must be ``0x0000``. Reserved to ensure 4-byte frame alignment.
58-
59-
0x0008
60-
61-
6
62-
63-
DA
64-
65-
Destination address.
66-
67-
0x000E
68-
69-
6
70-
71-
SA
72-
73-
Source address. This must not be the MAC address of the powerline device. This must be the MAC address of the local host serial interface as assigned by the SP or UART driver. The PLC device and the associated host interface must have different MAC address.
74-
75-
0x0014
76-
77-
4
78-
79-
VLAN
80-
81-
Virtual LAN tag. This field may be omitted.
82-
83-
0x0018
84-
85-
2
86-
87-
ET
88-
89-
Ethertype. This field starts at offset ``0x0014`` if ``VLAN`` is omitted.
90-
91-
0x001A
92-
93-
42 to 1500
94-
95-
BODY
96-
97-
Frame body. This field starts at offset ``0x0016`` and ranges from ``46`` to ``1500`` bytes if ``VLAN`` is omitted.
98-
99-
0x004A to 0x05F8
100-
101-
4
102-
103-
EOF
104-
105-
End Of Frame. Must be ``0x5555``. This field starts at offset ``0x0008`` plus ``FL``.
27+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
28+
| Offset | Length | Symbol | Description |
29+
+=======================+=============+=============+========================================================================+
30+
| 0x0000 | 4 | SOF | Start Of Frame. Must be ``0xAAAAAAAA``. |
31+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
32+
| 0x0004 | 2 | FL | The Ethernet frame length in little endian format. The frame starts |
33+
| | | | at offset ``0x0008`` here and includes all fields up to but excluding |
34+
| | | | ``EOF``. The minimum is ``60``. The maximum is ``1518`` if ``VLAN`` |
35+
| | | | is omitted and ``1522`` if not. |
36+
| | | | |
37+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
38+
| 0x0006 | 2 | RSVD | Must be ``0x0000``. Reserved to ensure 4-byte frame alignment. |
39+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
40+
| 0x0008 | 6 | DA | Destination Address |
41+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
42+
| 0x000E | 6 | SA | Source Address. This must not be the MAC address of the powerline |
43+
| | | | device. This must be the MAC address of the local host serial |
44+
| | | | interface as assigned by the SPI or UART driver. The PLC device |
45+
| | | | and the associated host interface must have different MAC addresses. |
46+
| | | | |
47+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
48+
| 0x0014 | 4 | VLAN | Virtual LAN tag. This field may be omitted. |
49+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
50+
| 0x0018 | 2 | ET | Ethertype. This field starts at offset ``0x0014`` if ``VLAN`` is |
51+
| | | | omitted. |
52+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
53+
| 0x001A | 42 to 1500 | BODY | Frame body. This field starts at offset ``0x0016`` and ranges from |
54+
| | | | ``46`` to ``1500`` bytes if ``VLAN`` is omitted. |
55+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
56+
| 0x004A to 0x005F8 | 4 | EOF | End Of Frame. Must be ``0x5555``. This field starts at offset |
57+
| | | | ``0x0008`` plus ``FL``. |
58+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
10659

10760
SPI Receive Frame
10861
-----------------
@@ -111,93 +64,41 @@ The SPI read frame occurs in response to a read interrupt generated by the QCA70
11164

11265
Allocate a 1532-byte buffer to accomodate the largest incoming serial packet. Read ``LEN`` to determine the size of the incoming serial packet. Read ``LEN`` bytes into the buffer. Beware that ``LEN`` is a multiple of 4-bytes so there may be a few trailing ``NUL`` bytes in buffer.
11366

114-
Offset
115-
116-
Length
117-
118-
Symbol
119-
120-
Description
121-
122-
0x0000
123-
124-
4
125-
126-
LEN
127-
128-
Hardware generated packet length. This field is only generated for SPI packets, not the UART packets.
129-
130-
0x0004
131-
132-
4
133-
134-
SOF
135-
136-
Start Of Frame. Must be ``0xAAAAAAAA``.
137-
138-
0x0008
139-
140-
2
141-
142-
FL
143-
144-
Ethernet frame length in little endian format. The frame starts at offset ``0x000C`` here and includes all fields up to but excluding ``EOF``. The minimum length is ``60``. The maximum is ``1518`` if ``VLAN`` is omitted and ``1522`` if not.
145-
146-
0x000A
147-
148-
2
149-
150-
RSVD
151-
152-
Must be ``0x0000``. Reserved to ensure 4-byte frame alignment.
153-
154-
0x000C
155-
156-
6
157-
158-
DA
159-
160-
Destination address.
161-
162-
0x0012
163-
164-
6
165-
166-
SA
167-
168-
Source address. This must not be the MAC address of the powerline device. This must be the MAC address of the local host serial interface as assigned by the SP or UART driver. The PLC device and the associated host interface must have different MAC address.
169-
170-
0x0018
171-
172-
4
173-
174-
VLAN
175-
176-
Virtual LAN tag. This field may be omitted.
177-
178-
0x001C
179-
180-
2
181-
182-
ET
183-
184-
Ethertype. This field starts offset ``0x0018`` if ``VLAN`` is omitted.
185-
186-
0x001E
187-
188-
42 to 1500
189-
190-
BODY
191-
192-
Frame body. This field starts at offset ``0x001A`` and ranges from ``46`` to ``1500`` bytes if ``VLAN`` is omitted.
193-
194-
0x004A to 0x05F8
195-
196-
4
197-
198-
EOF
199-
200-
End Of Frame. Must be ``0x5555``. This field starts at offset ``0x000C`` plus ``FL``.
67+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
68+
| Offset | Length | Symbol | Description |
69+
+=======================+=============+=============+========================================================================+
70+
| 0x0000 | 4 | LEN | Hardware generated packet length. This field is only generated for |
71+
| | | | SPI packets, not the UART packets. |
72+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
73+
| 0x0004 | 4 | SOF | Start Of Frame. Must be ``0xAAAAAAAA``. |
74+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
75+
| 0x0008 | 2 | FL | The Ethernet frame length in little endian format. The frame starts |
76+
| | | | at offset ``0x000C`` here and includes all fields up to but excluding |
77+
| | | | ``EOF``. The minimum is ``60``. The maximum is ``1518`` if ``VLAN`` |
78+
| | | | is omitted and ``1522`` if not. |
79+
| | | | |
80+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
81+
| 0x000A | 2 | RSVD | Must be ``0x0000``. Reserved to ensure 4-byte frame alignment. |
82+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
83+
| 0x000C | 6 | DA | Destination Address |
84+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
85+
| 0x0012 | 6 | SA | Source Address. This must not be the MAC address of the powerline |
86+
| | | | device. This must be the MAC address of the local host serial |
87+
| | | | interface as assigned by the SPI or UART driver. The PLC device |
88+
| | | | and the associated host interface must have different MAC addresses. |
89+
| | | | |
90+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
91+
| 0x0018 | 4 | VLAN | Virtual LAN tag. This field may be omitted. |
92+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
93+
| 0x001C | 2 | ET | Ethertype. This field starts at offset ``0x0018`` if ``VLAN`` is |
94+
| | | | omitted. |
95+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
96+
| 0x001E | 42 to 1500 | BODY | Frame body. This field starts at offset ``0x001A`` and ranges from |
97+
| | | | ``46`` to ``1500`` bytes if ``VLAN`` is omitted. |
98+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
99+
| 0x004A to 0x005F8 | 4 | EOF | End Of Frame. Must be ``0x5555``. This field starts at offset |
100+
| | | | ``0x000C`` plus ``FL``. |
101+
+-----------------------+-------------+-------------+------------------------------------------------------------------------+
201102

202103
.. _qcaspi1:
203104

0 commit comments

Comments
 (0)