NAME [edit section]

= NAME =
ov_transport_connect

SYNOPSIS [edit section]

= SYNOPSIS =
 * ov_transport_connect

DESCRIPTION [edit section]

= DESCRIPTION =
ov_transport_connect is an internal function used to establish a connection
to the target.  It is called during the "pre_test" phase in order to
do any required setup to prepare the connection with the board.

It uses the $TRANPORT variable to select the correct method to use
to connect.

In the case of the serial transport, this function makes sure the
board is logged in and sitting at a shell prompt.

As with other "ov_" functions, it can be overridden in the board file
for a board, to customize any operations required for connecting to a board.

This could be used for a number of things, including:
 * powering on a board
 * establishing a VPN connection to a remote lab
 * reserving a board using an external management system

EXAMPLES [edit section]

= EXAMPLES =
There are no current examples of this.

ENVIRONMENT and ARGUMENTS [edit section]

= ENVIRONMENT and ARGUMENTS =
 * $TRANSPORT - specifies the type of transport used to communicate with the board.  This should be one of "ssh", "serial", "ttc".
 * $LOGIN 
 * $PASSWORD

RETURN [edit section]

= RETURN =
Returns non-zero on error

SOURCE [edit section]

= SOURCE =
Located in ''overlays/base/base-board.fuegoclass''

SEE ALSO [edit section]

= SEE ALSO =
 * [[function_pre_test|pre_test]], [[function_ov_transport_cmd|ov_transport_cmd]], [[function_ov_transport_disconnect|ov_transport_disconnect]]