xenv_standalone.h File Reference

#include <string.h>

Defines

#define XENV_MEM_COPY(DestPtr, SrcPtr, Bytes)   memcpy((void *) DestPtr, (const void *) SrcPtr, (size_t) Bytes)
#define XENV_MEM_FILL(DestPtr, Data, Bytes)   memset((void *) DestPtr, (int) Data, (size_t) Bytes)
#define XENV_TIME_STAMP_GET(StampPtr)
#define XENV_TIME_STAMP_DELTA_US(Stamp1Ptr, Stamp2Ptr)   (0)
#define XENV_TIME_STAMP_DELTA_MS(Stamp1Ptr, Stamp2Ptr)   (0)
#define XENV_USLEEP(delay)

Typedefs

typedef int XENV_TIME_STAMP

Detailed Description

Defines common services specified by xenv.h.

Note:
This file is not intended to be included directly by driver code. Instead, the generic xenv.h file is intended to be included by driver code.
 MODIFICATION HISTORY:

 Ver   Who  Date     Changes
 ----- ---- -------- -----------------------------------------------
 1.00a wgr  02/28/07 Added cache handling macros.
 1.00a wgr  02/27/07 Simplified code. Deprecated old-style macro names.
 1.00a rmm  01/24/06 Implemented XENV_USLEEP. Assume implementation is being
                     used under Xilinx standalone BSP.
 1.00a xd   11/03/04 Improved support for doxygen.
 1.00a rmm  03/21/02 First release
 1.00a wgr  03/22/07 Converted to new coding style.
 1.00a rpm  06/29/07 Added udelay macro for standalone
 1.00a xd   07/19/07 Included xparameters.h as XPAR_ constants are referred
                     to in MICROBLAZE section
 1.00a ecm  09/19/08 updated for v7.20 of Microblaze, new functionality

 

Define Documentation

#define XENV_MEM_COPY DestPtr,
SrcPtr,
Bytes   )     memcpy((void *) DestPtr, (const void *) SrcPtr, (size_t) Bytes)
 

Copies a non-overlapping block of memory.

Parameters:
DestPtr Destination address to copy data to.
SrcPtr Source address to copy data from.
Bytes Number of bytes to copy.
Returns:
None.
Note:
The use of XENV_MEM_COPY is deprecated. Use memcpy() instead.

This implemention MAY BREAK work if source and target memory area are overlapping.

#define XENV_MEM_FILL DestPtr,
Data,
Bytes   )     memset((void *) DestPtr, (int) Data, (size_t) Bytes)
 

Fills an area of memory with constant data.

Parameters:
DestPtr Destination address to copy data to.
Data Value to set.
Bytes Number of bytes to copy.
Returns:
None.
Note:
The use of XENV_MEM_FILL is deprecated. Use memset() instead.

#define XENV_TIME_STAMP_DELTA_MS Stamp1Ptr,
Stamp2Ptr   )     (0)
 

This macro is not yet implemented and always returns 0.

Parameters:
Stamp1Ptr is the first sampled time stamp.
Stamp2Ptr is the second sampled time stamp.
Returns:
0
Note:
This macro must be implemented by the user.

#define XENV_TIME_STAMP_DELTA_US Stamp1Ptr,
Stamp2Ptr   )     (0)
 

This macro is not yet implemented and always returns 0.

Parameters:
Stamp1Ptr is the first sampled time stamp.
Stamp2Ptr is the second sampled time stamp.
Returns:
0
Note:
This macro must be implemented by the user.

#define XENV_TIME_STAMP_GET StampPtr   ) 
 

Time is derived from the 64 bit PPC timebase register

Parameters:
StampPtr is the storage for the retrieved time stamp.
Returns:
None.
Note:
Signature: void XENV_TIME_STAMP_GET(XTIME_STAMP *StampPtr)

This macro must be implemented by the user.

#define XENV_USLEEP delay   ) 
 

XENV_USLEEP(unsigned delay)

Delay the specified number of microseconds. Not implemented without OS support.

Parameters:
delay Number of microseconds to delay.
Returns:
None.


Typedef Documentation

typedef int XENV_TIME_STAMP
 

A structure that contains a time stamp used by other time stamp macros defined below. This structure is processor dependent.


Generated on Thu Feb 13 14:48:12 2014 for 2014.1_doc by  doxygen 1.4.5