setbootmode.bat / cafex setbootmode - Update CAT-DEV Firmware and Change Bootmode

Syntax

setbootmode.bat [<options>] <bootmode> 
    
cafex setbootmode [<options>] <bootmode>
NOTE:
Use the setbootmode.bat script instead of calling this command directly. Directly calling this command will not set the environment variable CAFE_BOOT_MODE for the current Cafe session, and will need to be set manually. The setbootmode.bat script will accept all options described below.

Options

-quick | -Q If the dual bootloader is installed, change only the boot mode environment variables.
-production | -P If the CAT-DEV and the environment variable CAFE_BOOT_MODE are set to NAND, then install the update, but use the production bootloader instead of the mixed one.
-reflash Delete all information stored on the physical NAND during the update.
-noreflash Retain user information on the physical NAND after the update.
<bootmode> Valid arguments are PCFS or NAND.
-h Print a list of the available options.

Return Values

-16 SETBOOTMODE_FAILED
-15 UPDATE_INVALID_OPTION
-4 BAD_ARGUMENT
0 OK
1 SETBOOTMODE_BAD_MODE

Description

setbootmode.bat and cafex setbootmode are host PC tools that update the boot firmware on the CAT-DEV and changes both the CAT-DEV and the Cafe command prompt's environment to the selected mode. There are two different boot modes: PCFS and NAND. For information, see Running Applications Overview.

The preferred tool for Cafe is setbootmode.bat.

Examples

Update the CAT-DEV firmware and change the bootmode to PCFS

Issue the following command from the Cafe command prompt:

setbootmode.bat PCFS

If you are using a Cafe Cygwin shell with USE_CAFEX=1 (default):

source setbootmode PCFS

This will update the CAT-DEV with the SDK's firmware. Additionally, it will set the CAT-DEV and environment variable CAFE_BOOT_MODE to PCFS. Note that it will install the dual bootloader. For more information about boot modes, see Running Applications Overview.

Install the production NAND bootloader

Issue the following command from a Cafe command prompt:

setbootmode.bat -production NAND

This will update the CAT-DEV with the SDK's firmware. Additionally, it will install the "production" bootloader and set the CAT-DEV and environment variable CAFE_BOOT_MODE to NAND. For more information about the production bootloader, see Running Applications Overview.

Change the boot mode to PCFS without updating the firmware

Issue the following command from the Cafe command prompt:

setbootmode.bat -quick PCFS

This command quickly changes the CAT-DEV's boot mode to the specified mode, in this case PCFS, without going through the lengthy firmware update process.

NOTE:
The dual bootloader must be installed to use this option. If it is not installed, then performing a cafex update or a cafex recover -bootloader will install it.

See Also

cafex
cafex update
Change Boot Modes
Running Applications Overview

Revision History

2014/09/24 Updated content and note.
2014/08/22 Additional options added.
2014/06/26 Return values added.
2014/03/17 Initial version.


CONFIDENTIAL