plugins/consoles/vt100cons/doc/vt100cons.pod
changeset 27 17e35ffe449b
parent 0 7f656887cf89
child 28 169dfbeff8ee
equal deleted inserted replaced
26:5d370dafea69 27:17e35ffe449b
    76 
    76 
    77 =item * C<rate=value>
    77 =item * C<rate=value>
    78 
    78 
    79 If present, set the baud rate of the serial port. Allowed values are: 115200, 57600, 19200, 9600. If specified, the port is configured with the following settings: rate as specified; data bits 8; stop bits 1; parity none; handshake 0, terminator count 0. For virtual serial ports (eg USB ACMs or Bluetooth serial ports) it is generally not necessary to configure hardware attributes so the rate parameter should not be specified.
    79 If present, set the baud rate of the serial port. Allowed values are: 115200, 57600, 19200, 9600. If specified, the port is configured with the following settings: rate as specified; data bits 8; stop bits 1; parity none; handshake 0, terminator count 0. For virtual serial ports (eg USB ACMs or Bluetooth serial ports) it is generally not necessary to configure hardware attributes so the rate parameter should not be specified.
    80 
    80 
       
    81 =item * C<debug>
       
    82 
       
    83 If present, the console will print out some debugging diagnostics to the underlying console during construction.
       
    84 
    81 =back
    85 =back
    82 
    86 
    83 Each keyword and value must be separated by an equals ('=') character. There may be whitespace either side of this. Each keword / value pair must be separated by a comma (',') character. Again, there may be whitespace either side of this. The name values may not contain either equals or comma characters as no form of escaping is currently supported.
    87 Each keyword and value must be separated by an equals ('=') character. There may be whitespace either side of this. Each keword / value pair must be separated by a comma (',') character. Again, there may be whitespace either side of this. The name values may not contain either equals or comma characters as no form of escaping is currently supported.
    84 
    88 
    85 =head3 Example Configuration Strings
    89 =head3 Example Configuration Strings
   262 
   266 
   263 This console is intended for early on in board bring-up when C32 is not available, but there is a working uart driver. Compare to vt100debugport.dll, which is only worth using when there isn't even a uart driver available but the debug port and serial keyboard driver are available. Unlike vt100debugport.dll, this console does not have any serial emulation restrictions so the full range of services such as binary mode and control keys are available. The C<--console-title> argument is used to specify the port number and other options in a similar way to vt100cons:
   267 This console is intended for early on in board bring-up when C32 is not available, but there is a working uart driver. Compare to vt100debugport.dll, which is only worth using when there isn't even a uart driver available but the debug port and serial keyboard driver are available. Unlike vt100debugport.dll, this console does not have any serial emulation restrictions so the full range of services such as binary mode and control keys are available. The C<--console-title> argument is used to specify the port number and other options in a similar way to vt100cons:
   264 
   268 
   265     fshell --console vt100busdevcons.dll --console-title port=2
   269     fshell --console vt100busdevcons.dll --console-title port=2
   266 
   270 
   267 If an option isn't specified, the following are assumed: pdd=euart, ldd=ecomm, rate=115200.
   271 If an option isn't specified, the following are assumed: pdd=euart (ecdrv on emulator), ldd=ecomm, rate=EBpsAutobaud.
   268 
   272 
   269 =head1 Copyright
   273 =head1 Copyright
   270 
   274 
   271 Copyright (c) 2008-2010 Accenture. All rights reserved.
   275 Copyright (c) 2008-2010 Accenture. All rights reserved.
   272 
   276