Mistake on this page?
Report an issue in GitHub or email us
Typedefs | Functions
synopGMAC_plat.h File Reference

This file serves as the wrapper for the platform/OS dependent functions It is needed to modify these functions accordingly based on the platform and the OS. More...

#include <stdio.h>
#include "NuMicro.h"

Go to the source code of this file.

Typedefs

typedef unsigned char u8
 Define 8-bit unsigned data type. More...
 
typedef unsigned short u16
 Define 16-bit unsigned data type. More...
 
typedef unsigned int u32
 Define 32-bit unsigned data type. More...
 
typedef signed int s32
 Define 32-bit signed data type. More...
 

Functions

void plat_delay (uint32_t ticks)
 These are the wrapper function prototypes for OS/platform related routines. More...
 
static u32 __INLINE synopGMACReadReg (u32 *RegBase, u32 RegOffset)
 The Low level function to read register contents from Hardware. More...
 
static void __INLINE synopGMACWriteReg (u32 *RegBase, u32 RegOffset, u32 RegData)
 The Low level function to write to a register in Hardware. More...
 
static void __INLINE synopGMACSetBits (u32 *RegBase, u32 RegOffset, u32 BitPos)
 The Low level function to set bits of a register in Hardware. More...
 
static void __INLINE synopGMACClearBits (u32 *RegBase, u32 RegOffset, u32 BitPos)
 The Low level function to clear bits of a register in Hardware. More...
 
static bool __INLINE synopGMACCheckBits (u32 *RegBase, u32 RegOffset, u32 BitPos)
 The Low level function to Check the setting of the bits. More...
 

Detailed Description

This file serves as the wrapper for the platform/OS dependent functions It is needed to modify these functions accordingly based on the platform and the OS.

Whenever the synopsys GMAC driver ported on to different platform, this file should be handled at most care. The corresponding function definitions for non-inline functions are available in synopGMAC_plat.c file.

Definition in file synopGMAC_plat.h.

Typedef Documentation

typedef signed int s32

Define 32-bit signed data type.

Definition at line 55 of file synopGMAC_plat.h.

typedef unsigned short u16

Define 16-bit unsigned data type.

Definition at line 53 of file synopGMAC_plat.h.

typedef unsigned int u32

Define 32-bit unsigned data type.

Definition at line 54 of file synopGMAC_plat.h.

typedef unsigned char u8

Define 8-bit unsigned data type.

Definition at line 52 of file synopGMAC_plat.h.

Function Documentation

void plat_delay ( uint32_t  ticks)

These are the wrapper function prototypes for OS/platform related routines.

static bool __INLINE synopGMACCheckBits ( u32 RegBase,
u32  RegOffset,
u32  BitPos 
)
static

The Low level function to Check the setting of the bits.

Parameters
[in]pointerto the base of register map
[in]Offsetfrom the base
[in]Bitmask to set bits to logical 1
Returns
returns TRUE if set to '1' returns FALSE if set to '0'. Result undefined there are no bit set in the BitPos argument.

Definition at line 172 of file synopGMAC_plat.h.

static void __INLINE synopGMACClearBits ( u32 RegBase,
u32  RegOffset,
u32  BitPos 
)
static

The Low level function to clear bits of a register in Hardware.

Parameters
[in]pointerto the base of register map
[in]Offsetfrom the base
[in]Bitmask to clear bits to logical 0
Returns
void

Definition at line 153 of file synopGMAC_plat.h.

static u32 __INLINE synopGMACReadReg ( u32 RegBase,
u32  RegOffset 
)
static

The Low level function to read register contents from Hardware.

Parameters
[in]pointerto the base of register map
[in]Offsetfrom the base
Returns
Returns the register contents

Definition at line 98 of file synopGMAC_plat.h.

static void __INLINE synopGMACSetBits ( u32 RegBase,
u32  RegOffset,
u32  BitPos 
)
static

The Low level function to set bits of a register in Hardware.

Parameters
[in]pointerto the base of register map
[in]Offsetfrom the base
[in]Bitmask to set bits to logical 1
Returns
void

Definition at line 133 of file synopGMAC_plat.h.

static void __INLINE synopGMACWriteReg ( u32 RegBase,
u32  RegOffset,
u32  RegData 
)
static

The Low level function to write to a register in Hardware.

Parameters
[in]pointerto the base of register map
[in]Offsetfrom the base
[in]Datato be written
Returns
void

Definition at line 115 of file synopGMAC_plat.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.