binimage.h File Reference

#include <stdio.h>
#include <stdint.h>
#include <stddef.h>

Go to the source code of this file.

Macros
#define	BINIMAGE_MAGIC0   0x47u /* 'G' */
#define	BINIMAGE_MAGIC1   0x45u /* 'E' */
#define	BINIMAGE_MAGIC2   0x31u /* '1' */
#define	BINIMAGE_MAGIC3   0x32u /* '2' */
#define	BINIMAGE_VERSION   0x01u
#define	BINIMAGE_HDR_SIZE   12

Enumerations
enum	{   BINIMAGE_OK = 0 , BINIMAGE_E_IO = -1 , BINIMAGE_E_MAGIC = -2 , BINIMAGE_E_VERSION = -3 ,   BINIMAGE_E_TRUNCATED = -4 , BINIMAGE_E_TOOBIG = -5 , BINIMAGE_E_RANGE = -6 }

Functions
int	binimage_write (FILE *fp, uint16_t origin, uint16_t entry, const uint8_t *img, uint16_t len)
int	binimage_read (FILE *fp, uint16_t *origin, uint16_t *entry, uint8_t *buf, size_t bufcap, uint16_t *len)
const char *	binimage_strerror (int code)

Macro Definition Documentation

BINIMAGE_HDR_SIZE

#define BINIMAGE_HDR_SIZE   12

Definition at line 43 of file binimage.h.

BINIMAGE_MAGIC0

#define BINIMAGE_MAGIC0   0x47u /* 'G' */

Definition at line 38 of file binimage.h.

BINIMAGE_MAGIC1

#define BINIMAGE_MAGIC1   0x45u /* 'E' */

Definition at line 39 of file binimage.h.

BINIMAGE_MAGIC2

#define BINIMAGE_MAGIC2   0x31u /* '1' */

Definition at line 40 of file binimage.h.

BINIMAGE_MAGIC3

#define BINIMAGE_MAGIC3   0x32u /* '2' */

Definition at line 41 of file binimage.h.

BINIMAGE_VERSION

#define BINIMAGE_VERSION   0x01u

Definition at line 42 of file binimage.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
BINIMAGE_OK
BINIMAGE_E_IO
BINIMAGE_E_MAGIC
BINIMAGE_E_VERSION
BINIMAGE_E_TRUNCATED
BINIMAGE_E_TOOBIG
BINIMAGE_E_RANGE

Definition at line 46 of file binimage.h.

Function Documentation

binimage_read()

int binimage_read	(	FILE *	fp,
		uint16_t *	origin,
		uint16_t *	entry,
		uint8_t *	buf,
		size_t	bufcap,
		uint16_t *	len
	)

Definition at line 41 of file binimage.c.

binimage_strerror()

const char * binimage_strerror

(

int

code

)

Definition at line 79 of file binimage.c.

binimage_write()

int binimage_write	(	FILE *	fp,
		uint16_t	origin,
		uint16_t	entry,
		const uint8_t *	img,
		uint16_t	len
	)

Definition at line 10 of file binimage.c.