serial.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Benjamin Valentin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef RIOTBOOT_SERIAL_H
#define RIOTBOOT_SERIAL_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RIOTBOOT_CMD_BOOT       'b'
 
#define RIOTBOOT_CMD_ERASE      'e'
 
#define RIOTBOOT_CMD_WRITE      'w'
 
#define RIOTBOOT_CMD_GET_PAGE   'P'
#define RIOTBOOT_STAT_OK        '.'
#define RIOTBOOT_STAT_BAD_CRC   '?'
#define RIOTBOOT_STAT_ILLEGAL   '!'
/* sent to stop auto-boot */
#define RIOTBOOT_ENTER_LOADER   'B'
/* sent to probe if auto-boot is paused and riotboot is active */
#define RIOTBOOT_PROBE          '?'
 
/* continuously sent by riotboot before booting */
#define RIOTBOOT_STAT_WAITING   'b'
/* indicates riotboot is ready to accept commands */
#define RIOTBOOT_STAT_READY     '>'
#ifndef RIOTBOOT_CRC8_POLY
#define RIOTBOOT_CRC8_POLY      (0x31)
#endif
 
int riotboot_serial_loader(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RIOTBOOT_SERIAL_H */