pico_binary_info.h

#pragma once
 
#include <stddef.h>
#include <stdint.h>


enum pico_binary_info_error {
  PICO_BI_ENOTFOUND = 1,

  PICO_BI_ENOHEADER,

  PICO_BI_EWRONGTYPE,

  PICO_BI_ERANGE,

  PICO_BI_EBADADDR,
};

 

struct pico_binary_info {
  // Pointer to the "in-memory" image, NULL if using file descriptors
  const uint8_t *image;
 
  // File handle for a "file descriptor" image, or -1 if using the in-memory buffer
  int fd;
 
  // Total size of the image
  size_t image_len;
 
  // File offset for the start of the binary info record table
  size_t table_off;
 
  // End of the binary info record table
  size_t table_end;
 
  // File offset for the start of the copy-mapping table
  long mapping_off;
};


int pico_binary_info_init(struct pico_binary_info *info, const uint8_t *image, size_t len);

int pico_binary_info_init_fd(struct pico_binary_info *info, int fd, size_t len);



int pico_binary_info_get_int(struct pico_binary_info *info, uint16_t tag, uint32_t id, uint32_t *out);

int pico_binary_info_get_string(struct pico_binary_info *info, uint16_t tag, uint32_t id, char *out, size_t out_len);



int pico_binary_info_get_program_name(struct pico_binary_info *info, char *out, size_t out_len);

int pico_binary_info_get_program_version(struct pico_binary_info *info, char *out, size_t out_len);

int pico_binary_info_get_program_build_date(struct pico_binary_info *info, char *out, size_t out_len);

int pico_binary_info_get_program_url(struct pico_binary_info *info, char *out, size_t out_len);

int pico_binary_info_get_program_description(struct pico_binary_info *info, char *out, size_t out_len);

int pico_binary_info_get_program_feature(struct pico_binary_info *info, char *out, size_t out_len);

int pico_binary_info_get_program_build_attribute(struct pico_binary_info *info, char *out, size_t out_len);

int pico_binary_info_get_sdk_version(struct pico_binary_info *info, char *out, size_t out_len);

int pico_binary_info_get_pico_board(struct pico_binary_info *info, char *out, size_t out_len);

int pico_binary_info_get_boot2_name(struct pico_binary_info *info, char *out, size_t out_len);

int pico_binary_info_get_binary_end(struct pico_binary_info *info, uint32_t *out);