precision-converters-firmware
Macros | Functions
board_info.c File Reference

Hardware board information read and parse module. More...

#include <stdbool.h>
#include <string.h>
#include <stdlib.h>
#include "board_info.h"
#include "no_os_error.h"
Include dependency graph for board_info.c:

Macros

#define SDP_EEPROM_DATA_MAX_LEN   256
 
#define SDP_EEPROM_LEGACY_BOARD_ID_LEN   18
 
#define SDP_EEPROM_HEADER_LEN   10
 
#define SDP_EEPROM_HEADER_INDX   8
 
#define SDP_EEPROM_DATA_INDX   10
 
#define SDP_EEPROM_RECORD_FOOTER_LEN   3
 

Functions

int32_t read_board_info (struct no_os_eeprom_desc *desc, struct board_info *board_info)
 Read board information from EEPROM. More...
 

Detailed Description

Hardware board information read and parse module.

Copyright 2022(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

◆ SDP_EEPROM_DATA_INDX

#define SDP_EEPROM_DATA_INDX   10

◆ SDP_EEPROM_DATA_MAX_LEN

#define SDP_EEPROM_DATA_MAX_LEN   256

◆ SDP_EEPROM_HEADER_INDX

#define SDP_EEPROM_HEADER_INDX   8

◆ SDP_EEPROM_HEADER_LEN

#define SDP_EEPROM_HEADER_LEN   10

◆ SDP_EEPROM_LEGACY_BOARD_ID_LEN

#define SDP_EEPROM_LEGACY_BOARD_ID_LEN   18

◆ SDP_EEPROM_RECORD_FOOTER_LEN

#define SDP_EEPROM_RECORD_FOOTER_LEN   3

Function Documentation

◆ read_board_info()

int32_t read_board_info ( struct no_os_eeprom_desc *  desc,
struct board_info board_info 
)

Read board information from EEPROM.

Parameters
desc[in]- EEPROM descriptor
board_info[in,out]- Pointer to board info structure
Returns
0 in case of success, negative error code otherwise