axi_sysid.h File Reference

Driver for the Analog Devices AXI-SYSID core. More...

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

Include dependency graph for axi_sysid.h:

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

Go to the source code of this file.

Classes
struct	axi_sysid
struct	sysid_header_v1
struct	build_info_header_v1
struct	build_info_header_v1_1
struct	axi_sysid_core_info
struct	axi_sysid_init_param

Macros
#define	AXI_SYSOD_H_
#define	AXI_SYSID_VER_1_00_A   0x10061
#define	AXI_SYSID_VER_1_01_A   0x10161
#define	AXI_SYSID_WORD_SIZE   sizeof(uint32_t)
#define	AXI_SYSID_REG_ROM_ADDR_WIDTH   0x40
#define	AXI_SYSID_REG_VERSION   0x0000
#define	AXI_SYSID_REG_PERIPH_ID   0x0004
#define	AXI_SYSID_REG_SCRATCH   0x0008
#define	AXI_SYSID_REG_ID   0x000c
#define	AXI_SYSID_REG_SYSROM_START   0x0800
#define	AXI_SYSID_REG_PRROM_START   0x1000
#define	AXI_PCORE_VER_MAJOR(version)   (version >> 16)
#define	AXI_PCORE_VER_MINOR(version)   ((version >> 8) & 0xff)
#define	AXI_PCORE_VER_LETTER(version)   (version & 0xff)

Enumerations
enum	sysid_header_version {   AXI_SYSID_HEADER_V1 = 1,   AXI_SYSID_HEADER_V2 }

Functions
int32_t	axi_sysid_init (struct axi_sysid **sysid_core, const struct axi_sysid_init_param *init)
int32_t	axi_sysid_remove (struct axi_sysid *sysid)
char *	axi_sysid_get_fpga_board (struct axi_sysid *sysid)

Detailed Description

Driver for the Analog Devices AXI-SYSID core.

Author

GMois (georg.nosp@m.e.mo.nosp@m.is@an.nosp@m.alog.nosp@m..com)

Copyright 2023(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:

• 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

AXI_PCORE_VER_LETTER

#define AXI_PCORE_VER_LETTER

(

version

)

(version & 0xff)

AXI_PCORE_VER_MAJOR

#define AXI_PCORE_VER_MAJOR

(

version

)

(version >> 16)

AXI_PCORE_VER_MINOR

#define AXI_PCORE_VER_MINOR

(

version

)

((version >> 8) & 0xff)

AXI_SYSID_REG_ID

#define AXI_SYSID_REG_ID   0x000c

AXI_SYSID_REG_PERIPH_ID

#define AXI_SYSID_REG_PERIPH_ID   0x0004

AXI_SYSID_REG_PRROM_START

#define AXI_SYSID_REG_PRROM_START   0x1000

AXI_SYSID_REG_ROM_ADDR_WIDTH

#define AXI_SYSID_REG_ROM_ADDR_WIDTH   0x40

AXI_SYSID_REG_SCRATCH

#define AXI_SYSID_REG_SCRATCH   0x0008

AXI_SYSID_REG_SYSROM_START

#define AXI_SYSID_REG_SYSROM_START   0x0800

AXI_SYSID_REG_VERSION

#define AXI_SYSID_REG_VERSION   0x0000

AXI_SYSID_VER_1_00_A

#define AXI_SYSID_VER_1_00_A   0x10061

AXI_SYSID_VER_1_01_A

#define AXI_SYSID_VER_1_01_A   0x10161

AXI_SYSID_WORD_SIZE

#define AXI_SYSID_WORD_SIZE   sizeof(uint32_t)

AXI_SYSOD_H_

#define AXI_SYSOD_H_

Enumeration Type Documentation

sysid_header_version

enum sysid_header_version

Enumerator
AXI_SYSID_HEADER_V1
AXI_SYSID_HEADER_V2

Function Documentation

axi_sysid_get_fpga_board()

char* axi_sysid_get_fpga_board

(

struct axi_sysid *

sysid

)

Here is the caller graph for this function:

axi_sysid_init()

int32_t axi_sysid_init	(	struct axi_sysid **	sysid_core,
		const struct axi_sysid_init_param *	init
	)

Here is the caller graph for this function:

axi_sysid_remove()

int32_t axi_sysid_remove

(

struct axi_sysid *

sysid

)

Here is the caller graph for this function: