diff options
author | Jeff Garzik <jeff@garzik.org> | 2008-08-07 04:05:46 -0400 |
---|---|---|
committer | Jeff Garzik <jgarzik@redhat.com> | 2008-08-07 04:05:46 -0400 |
commit | 3859069bc3358772b08bd91efe9edec39a746ea8 (patch) | |
tree | 9ffe71711dd98cf511ad21d9990c597de0ac3b2b /Documentation | |
parent | e2c709b0ba2886b5438b666222b4b3faf82d65a9 (diff) | |
parent | 867240f7b2a37b1be4ba37d904a9064a96c82099 (diff) |
Merge branch 'for-jeff' of git://git.kernel.org/pub/scm/linux/kernel/git/chris/linux-2.6 into tmp
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/DocBook/z8530book.tmpl | 38 |
1 files changed, 12 insertions, 26 deletions
diff --git a/Documentation/DocBook/z8530book.tmpl b/Documentation/DocBook/z8530book.tmpl index 42c75ba71ba2..a42a8a4c7689 100644 --- a/Documentation/DocBook/z8530book.tmpl +++ b/Documentation/DocBook/z8530book.tmpl | |||
@@ -69,12 +69,6 @@ | |||
69 | device to be used as both a tty interface and as a synchronous | 69 | device to be used as both a tty interface and as a synchronous |
70 | controller is a project for Linux post the 2.4 release | 70 | controller is a project for Linux post the 2.4 release |
71 | </para> | 71 | </para> |
72 | <para> | ||
73 | The support code handles most common card configurations and | ||
74 | supports running both Cisco HDLC and Synchronous PPP. With extra | ||
75 | glue the frame relay and X.25 protocols can also be used with this | ||
76 | driver. | ||
77 | </para> | ||
78 | </chapter> | 72 | </chapter> |
79 | 73 | ||
80 | <chapter id="Driver_Modes"> | 74 | <chapter id="Driver_Modes"> |
@@ -179,35 +173,27 @@ | |||
179 | <para> | 173 | <para> |
180 | If you wish to use the network interface facilities of the driver, | 174 | If you wish to use the network interface facilities of the driver, |
181 | then you need to attach a network device to each channel that is | 175 | then you need to attach a network device to each channel that is |
182 | present and in use. In addition to use the SyncPPP and Cisco HDLC | 176 | present and in use. In addition to use the generic HDLC |
183 | you need to follow some additional plumbing rules. They may seem | 177 | you need to follow some additional plumbing rules. They may seem |
184 | complex but a look at the example hostess_sv11 driver should | 178 | complex but a look at the example hostess_sv11 driver should |
185 | reassure you. | 179 | reassure you. |
186 | </para> | 180 | </para> |
187 | <para> | 181 | <para> |
188 | The network device used for each channel should be pointed to by | 182 | The network device used for each channel should be pointed to by |
189 | the netdevice field of each channel. The dev-> priv field of the | 183 | the netdevice field of each channel. The hdlc-> priv field of the |
190 | network device points to your private data - you will need to be | 184 | network device points to your private data - you will need to be |
191 | able to find your ppp device from this. In addition to use the | 185 | able to find your private data from this. |
192 | sync ppp layer the private data must start with a void * pointer | ||
193 | to the syncppp structures. | ||
194 | </para> | 186 | </para> |
195 | <para> | 187 | <para> |
196 | The way most drivers approach this particular problem is to | 188 | The way most drivers approach this particular problem is to |
197 | create a structure holding the Z8530 device definition and | 189 | create a structure holding the Z8530 device definition and |
198 | put that and the syncppp pointer into the private field of | 190 | put that into the private field of the network device. The |
199 | the network device. The network device fields of the channels | 191 | network device fields of the channels then point back to the |
200 | then point back to the network devices. The ppp_device can also | 192 | network devices. |
201 | be put in the private structure conveniently. | ||
202 | </para> | 193 | </para> |
203 | <para> | 194 | <para> |
204 | If you wish to use the synchronous ppp then you need to attach | 195 | If you wish to use the generic HDLC then you need to register |
205 | the syncppp layer to the network device. You should do this before | 196 | the HDLC device. |
206 | you register the network device. The | ||
207 | <function>sppp_attach</function> requires that the first void * | ||
208 | pointer in your private data is pointing to an empty struct | ||
209 | ppp_device. The function fills in the initial data for the | ||
210 | ppp/hdlc layer. | ||
211 | </para> | 197 | </para> |
212 | <para> | 198 | <para> |
213 | Before you register your network device you will also need to | 199 | Before you register your network device you will also need to |
@@ -314,10 +300,10 @@ | |||
314 | buffer in sk_buff format and queues it for transmission. The | 300 | buffer in sk_buff format and queues it for transmission. The |
315 | caller must provide the entire packet with the exception of the | 301 | caller must provide the entire packet with the exception of the |
316 | bitstuffing and CRC. This is normally done by the caller via | 302 | bitstuffing and CRC. This is normally done by the caller via |
317 | the syncppp interface layer. It returns 0 if the buffer has been | 303 | the generic HDLC interface layer. It returns 0 if the buffer has been |
318 | queued and non zero values for queue full. If the function accepts | 304 | queued and non zero values for queue full. If the function accepts |
319 | the buffer it becomes property of the Z8530 layer and the caller | 305 | the buffer it becomes property of the Z8530 layer and the caller |
320 | should not free it. | 306 | should not free it. |
321 | </para> | 307 | </para> |
322 | <para> | 308 | <para> |
323 | The function <function>z8530_get_stats</function> returns a pointer | 309 | The function <function>z8530_get_stats</function> returns a pointer |