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

#include <stdint.h>
#include "no_os_eeprom.h"

Include dependency graph for board_info.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	board_info

Macros
#define	BOARD_ID_MAX_LEN 50

#define	BOARD_NAME_MAX_LEN 100

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 header file.

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

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

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

◆ BOARD_ID_MAX_LEN

#define BOARD_ID_MAX_LEN 50

◆ BOARD_NAME_MAX_LEN

#define BOARD_NAME_MAX_LEN 100

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

Classes