roboot/boot/roboot_config_template.h File Reference

---

Detailed Description

Exemplary configuration file for ROBOOT.

License:

ROBOOT ver. 0.1.0 - Copyright (C) 2010 AGH UST

This file is part of the ROBOOT (RObus BOOTloader) project. ROBOOT is developed at the Department of Electronics, AGH University of Science and Technology in Krakow, Poland.

The ROBOOT project uses dual-licensing. You can use it for free for non-commercial, open source projects. See license.txt for details or visit project home page at http://www.wsn.agh.edu.pl/?q=roboot

THIS SOFTWARE IS PROVIDED 'AS IS'. NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. AGH UST SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.

Author:

Artur Lipowski, Łukasz Krzak

Purpose:

ROBOOT

Compiler:

GCC

Hardware:

independent

Documented in:

doxygen

Comments:

You can copy this directly into your bootloader to start it running. It is advised to update the definitions below for your specific setup.

Definition in file roboot_config_template.h.

#include "roboot_config_defs.h"

Go to the source code of this file.

Defines
#define	ROBOOT_DEVICE_VERSION   1
#define	ROBOOT_HASH_TYPE   ROBOOT_HASH_CRC32
#define	ROBOOT_CIPHER_TYPE   ROBOOT_CIPHER_NONE
#define	ROBOOT_USE_ASSYMETRIC_CIPHER   0
#define	ROBOOT_IMAGE_CHECK_TYPE   ROBOOT_IMAGE_CHECK_APPVER
#define	ROBOOT_FLASH_WRITE_CHUNK_LEN   1024
#define	ROBOOT_IMG_BUFFER_SIZE   2048
#define	XMODEM_BAUD_RATE   19200

---

Define Documentation

#define ROBOOT_DEVICE_VERSION   1

Device version

Definition at line 42 of file roboot_config_template.h.

#define ROBOOT_HASH_TYPE   ROBOOT_HASH_CRC32

Sets the type of algorithm used for checking ROBOOT image integrity. Possible values: ROBOOT_HASH_NONE - none (read and compare) ROBOOT_HASH_CRC32 - CRC32 ROBOOT_HASH_MD5 - MD5 Default is ROBOOT_HASH_CRC32

Definition at line 52 of file roboot_config_template.h.

#define ROBOOT_CIPHER_TYPE   ROBOOT_CIPHER_NONE

Sets the type of ciphering algorithm. Possible values: ROBOOT_CIPHER_NONE - no ciphering ROBOOT_CIPHER_XTEA - XTEA algorithm Default is ROBOOT_CIPHER_NONE

Definition at line 61 of file roboot_config_template.h.

Referenced by ROBOOT_GetCipherType().

#define ROBOOT_USE_ASSYMETRIC_CIPHER   0

Controls the usage of asymetric ciphering. Possible values: 0 - disabled 1 - enabled Default is 0 (disabled)

Definition at line 70 of file roboot_config_template.h.

#define ROBOOT_IMAGE_CHECK_TYPE   ROBOOT_IMAGE_CHECK_APPVER

Sets the image checking algorithm Possible values: ROBOOT_IMAGE_CHECK_APPVER - application ID and device version range ROBOOT_IMAGE_CHECK_APPID - application ID ROBOOT_IMAGE_CHECK_DEVID - device ID Default is ROBOOT_IMAGE_CHECK_APPVER

Definition at line 80 of file roboot_config_template.h.

#define ROBOOT_FLASH_WRITE_CHUNK_LEN   1024

Size of a single data chunk written to FLASH

Definition at line 85 of file roboot_config_template.h.

#define ROBOOT_IMG_BUFFER_SIZE   2048

Size of the ROBOOT processing buffer. This should be large enough to keep two transport layer units (e.g. XMODEM packet) or two FLASH_WRITE_CHUNK_LEN (whatever is larger).

Definition at line 91 of file roboot_config_template.h.