Doug / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit f20ce779bb31a90985b0daea2bf0aaf009d21b81

Authored by Kumar Sanghvi
Committed by David S. Miller
1 parent b3d6255388
Exists in master and in 7 other branches imx_3.0.35_4.1.0, imx_3.10.17_1.0.1_ga, imx_3.10.53_1.1.0_ga, imx_3.14.28_1.0.0_ga, smarc-imx_3.10.53_1.1.0_ga, smarc-imx_3.14.28_1.0.0_ga, smarc-l5.0.0_1.0.0-ga

Documentation: Update Phonet doc for Pipe controller changes 

Updates to Phonet doc for Pipe controller 'connect' socket
implementation and changes related to socket options.

Signed-off-by: Kumar Sanghvi <kumar.sanghvi@stericsson.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

Showing 1 changed file with 14 additions and 18 deletions Side-by-side Diff

Documentation/networking/phonet.txt
Diff comments   View file @ f20ce77
... ... @@ -199,32 +199,28 @@
199 199  
200 200 The implementation adds socket options at SOL_PNPIPE level:
201 201  
202   - PNPIPE_CREATE
203   - It accepts an integer argument where-in
204   - lower order 16 bits: pn_dev and pn_port pair for remote pep.
205   - higher order 16 bits: 8 bit pipe-handle
  202 + PNPIPE_PIPE_HANDLE
  203 + It accepts an integer argument for setting value of pipe handle.
206 204  
207   - It sends a PNS_PEP_CONNECT_REQ on sequenced socket itself. On getting
208   - PNS_PEP_CONNECT_RESP, it sends PNS_PEP_CONNECT_REQ to remote pep. On
209   - getting response from remote pep, it selects the best possible Flow
210   - control mechanism supported by remote-pep (modem) and then it sends
211   - PNS_PEP_CREATED_IND to the sequenced socket and to the remote pep.
212   -
213   - It then updates the pipe state associated with the sequenced socket to
214   - be PIPE_DISABLED.
215   -
216 205 PNPIPE_ENABLE accepts one integer value (int). If set to zero, the pipe
217 206 is disabled. If the value is non-zero, the pipe is enabled. If the pipe
218 207 is not (yet) connected, ENOTCONN is error is returned.
219 208  
220   - PNPIPE_DESTROY
221   - This will send out PNS_PEP_DISCONNECT_REQ on the sequenced socket and
222   - the remote pep.
223   - It will also update the pipe state associated with the sequenced socket
224   - to PIPE_IDLE
  209 +The implementation also adds socket 'connect'. On calling the 'connect', pipe
  210 +will be created between the source socket and the destination, and the pipe
  211 +state will be set to PIPE_DISABLED.
225 212  
226 213 After a pipe has been created and enabled successfully, the Pipe data can be
227 214 exchanged between the host-pep and remote-pep (modem).
  215 +
  216 +User-space would typically follow below sequence with Pipe controller:-
  217 +-socket
  218 +-bind
  219 +-setsockopt for PNPIPE_PIPE_HANDLE
  220 +-connect
  221 +-setsockopt for PNPIPE_ENCAP_IP
  222 +-setsockopt for PNPIPE_ENABLE
  223 +
228 224  
229 225 Authors
230 226 -------