Changes between Version 5 and Version 6 of newport

Timestamp:

11/30/2017 07:03:22 PM (7 years ago)

Author:

Tim Harvey

Comment:

added bootloader and hwconfig details

newport

@@ -57 +57 @@
 == Software ==
  * [#firmware Firmware (up to and including the Bootloader)]
+ * [#bootloader U-Boot Bootloader]
  * [#bsp Newport Board Support Packages and Operating Systems]
  * [#linux Linux kernel support]
@@ -140 +141 @@
 
 Boards with an Alternate boot device also have a boot watchdog such that if the current boot device fails to boot within 30 seconds, the board will power cycle primary power and attempt boot from the other boot device.
+
+
+[=#bootloader]
+== U-Boot Bootloader ==
+Gateworks supports the U-Boot Bootloader for the Newport product family. We provide pre-built firmware images (see [#firmware above) as well as source for building and/or modifying it yourself.
+
+One of the primary features of the Bootloader is to provide access to the {{{hwconfig}}} environment variable that the firmware uses for initial board configuration on power-up.
+
+[=#hwconfig]
+=== hwconfig ===
+The U-Boot Bootloader by convention provides a {{{hwconfig}}} environment variable which is used by the firmware (before U-Boot is loaded and executed) to configure board options at power-up. These options can include things such as:
+ * miniPCIe socket functions (ie PCIe vs mSATA vs USB 3.0)
+ * serial configuration (ie RS232 vs RS485)
+
+[=#socketconfig]
+==== hwconfig: miniPCIe Socket Configuration ====
+Newport board model socket options:
+ * GW630x:
+   - J9: PCIe
+   - J10: PCIe or SATA
+   - J11: PCIe or USB 3.0
+
+You can get/set the {{{hwconfig}}} variable within the U-Boot bootloader but you must reboot the board for it to take effect as the variable is acted upon in the Secondary Program Loader (SPL).
+
+Examples:
+ * GW630x:
+  - J10 PCIe, J11 PCIe (default)
+{{{#!bash
+setenv hwconfig 'j10:pcie;j11:pcie'; saveenv
+}}}
+  - J10 mSATA, J11 USB 3.0
+{{{#!bash
+setenv hwconfig 'j10:sata;j11:usb'; saveenv
+}}}
+  - J9/J10 disabled, J11 PCIe
+{{{#!bash
+setenv hwconfig 'j9:disabled;j10:disabled;j11:pcie'; saveenv
+}}}
+
+'''Note that {{{hwconfig}}} is also used for serial configuration so care should be taken to preserve that configuration if used''' 
+
+[=#serialconfig]
+==== hwconfig: serial Configuration ====
+Many boards in the Newport product family provide a 5-pin off-board serial connector that provides the following options:
+- 1x RS485 FD (UART2)
+- 1x RS485 HD (UART2)
+- 1x RS232 w/ hardware flow control (UART2)
+- 2x RS232 w/o hardware flow control (UART2/UART3)
+
+By default 2x RS232 with no flow control is enabled. To configure a different option use the {{{hwconfig}}} U-Boot env variable. The {{{mode}}} property of the {{{serial}}} option defines the initial configuration of the serial port(s). If RS485 is selected by the {{{mode}}} property the {{{term}}} property will select whether or not on-board termination is enabled.
+
+The {{{mode}}} property can have the following values:
+ * rs232 - 2x RS232 (UART2/UART3) without hardware flow control (default if not specified)
+ * rs232_dtr - RS232 (UART2) with hardware flow control
+ * rs485_hd - RS485 half-duplex
+ * rs485_fd - RS485 full-duplex
+
+Examples:
+ * enable RS485 half duplex no on-board termination
+{{{#!bash
+setenv hwconfig "serial:mode=rs485_hd,term=no"; saveenv
+}}}
+ * enable RS485 full duplex with on-board termination
+{{{#!bash
+setenv hwconfig "serial:mode=rs485_fd,term=yes"; saveenv
+}}}
+* enable RS232 with hardware flow-control:
+{{{#!bash
+setenv hwconfig "serial:mode=rs232_dtr"; saveenv
+}}}
+
+
+'''Note that {{{hwconfig}}} is also used for serial configuration so care should be taken to preserve that configuration if used'''