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:

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_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)
#define	AXI_PCORE_VER_MINOR(version)
#define	AXI_PCORE_VER_LETTER(version)

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.

SPDX-License-Identifier: BSD-3-Clause

Macro Definition Documentation

AXI_PCORE_VER_LETTER

#define AXI_PCORE_VER_LETTER

(

version

)

Value:

(version & 0xff)

AXI_PCORE_VER_MAJOR

#define AXI_PCORE_VER_MAJOR

(

version

)

Value:

(version >> 16)

AXI_PCORE_VER_MINOR

#define AXI_PCORE_VER_MINOR

(

version

)

Value:

((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)

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

)

axi_sysid_init()

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

axi_sysid_remove()

int32_t axi_sysid_remove

(

struct axi_sysid *

sysid

)