mcci_bootloader_types.h File Reference

#include "mcciadk_env.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdarg.h>

Go to the source code of this file.

Macros
#define	MCCI_BOOTLOADER_BEGIN_DECLS   /* nothing */
#define	MCCI_BOOTLOADER_END_DECLS   /* nothing */
#define	MCCI_BOOTLOADER_NORETURN_PFX   /* nothing */
#define	MCCI_BOOTLOADER_NORETURN_SFX   __attribute__((__noreturn__))
#define	MCCI_BOOTLOADER_NOT_REACHED()   __builtin_unreachable()

Typedefs
typedef uint32_t	McciBootloader_Milliseconds_t
	Time (in milliseconds)
typedef uint32_t	McciBootloaderError_t
	error codes for the bootloader
typedef uint32_t	McciBootloaderState_t
	Current boot system state.
typedef uint32_t	McciBootloaderStorageAddress_t
	Abstract type for storage byte addresses.

Macro Definition Documentation

MCCI_BOOTLOADER_BEGIN_DECLS

#define MCCI_BOOTLOADER_BEGIN_DECLS   /* nothing */

Definition at line 51 of file mcci_bootloader_types.h.

MCCI_BOOTLOADER_END_DECLS

#define MCCI_BOOTLOADER_END_DECLS   /* nothing */

Definition at line 52 of file mcci_bootloader_types.h.

MCCI_BOOTLOADER_NORETURN_PFX

#define MCCI_BOOTLOADER_NORETURN_PFX   /* nothing */

Definition at line 59 of file mcci_bootloader_types.h.

MCCI_BOOTLOADER_NORETURN_SFX

#define MCCI_BOOTLOADER_NORETURN_SFX   __attribute__((__noreturn__))

Definition at line 60 of file mcci_bootloader_types.h.

MCCI_BOOTLOADER_NOT_REACHED

#define MCCI_BOOTLOADER_NOT_REACHED

(

)

__builtin_unreachable()

Definition at line 63 of file mcci_bootloader_types.h.

Typedef Documentation

McciBootloader_Milliseconds_t

typedef uint32_t McciBootloader_Milliseconds_t

Time (in milliseconds)

Note

An unsigned integral type that represents time since boot in milliseconds. It's unsigned because that maakes deadline handling easier to understand in the face of overflows. Time is used for timeouts for I/O drivers.

Definition at line 119 of file mcci_bootloader_types.h.

McciBootloaderError_t

typedef uint32_t McciBootloaderError_t

error codes for the bootloader

Note

enum types don't have predictable width. So we declare this as a uint32_t, and have a separate declaration for the enum.

See also

McciBootloaderError_e

Definition at line 81 of file mcci_bootloader_types.h.

McciBootloaderState_t

typedef uint32_t McciBootloaderState_t

Current boot system state.

Note

enum types don't have predictable width. So we declare this as a uint32_t, and have a separate declaration for the enum.

See also

McciBootloaderState_e

Definition at line 99 of file mcci_bootloader_types.h.

McciBootloaderStorageAddress_t

typedef uint32_t McciBootloaderStorageAddress_t

Abstract type for storage byte addresses.

The bootloader assumes that boot images are wholly contained in the first 4 GiB of the storage device.

Definition at line 89 of file mcci_bootloader_types.h.