Binary Descriptors

Topics
	Binary Descriptor Definition
	Macros for defining binary descriptors in firmware images .
	Binary Descriptor Reading
	Functions for reading binary descriptors from firmware images .

Files
file	bindesc.h
	Header file for binary descriptors.

Macros
#define	BINDESC_MAGIC   0xb9863e5a7ea46046
	Magic number used to identify binary descriptor sections in firmware images.
#define	BINDESC_ALIGNMENT   4
	Required memory alignment for binary descriptor entries.
#define	BINDESC_ENTRY_HEADER_SIZE   (sizeof(struct bindesc_entry))
	Size of the header of a binary descriptor entry.

Binary Descriptor Types
#define	BINDESC_TYPE_UINT   0x0
	Unsigned integer data.
#define	BINDESC_TYPE_STR   0x1
	String data.
#define	BINDESC_TYPE_BYTES   0x2
	Byte array data.
#define	BINDESC_TYPE_DESCRIPTORS_END   0xf
	Marks the end of binary descriptor section.

Detailed Description

Macro Definition Documentation

BINDESC_ALIGNMENT

#define BINDESC_ALIGNMENT   4

#include <zephyr/bindesc.h>

Required memory alignment for binary descriptor entries.

BINDESC_ENTRY_HEADER_SIZE

#define BINDESC_ENTRY_HEADER_SIZE   (sizeof(struct bindesc_entry))

#include <zephyr/bindesc.h>

Size of the header of a binary descriptor entry.

BINDESC_MAGIC

#define BINDESC_MAGIC   0xb9863e5a7ea46046

#include <zephyr/bindesc.h>

Magic number used to identify binary descriptor sections in firmware images.

BINDESC_TYPE_BYTES

#define BINDESC_TYPE_BYTES   0x2

#include <zephyr/bindesc.h>

Byte array data.

BINDESC_TYPE_DESCRIPTORS_END

#define BINDESC_TYPE_DESCRIPTORS_END   0xf

#include <zephyr/bindesc.h>

Marks the end of binary descriptor section.

BINDESC_TYPE_STR

#define BINDESC_TYPE_STR   0x1

#include <zephyr/bindesc.h>

String data.

BINDESC_TYPE_UINT

#define BINDESC_TYPE_UINT   0x0

#include <zephyr/bindesc.h>

Unsigned integer data.