---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > RIM / V0-0-3

Constituent: rim     Tag: mcp750

---

         

---

rim.c File Reference

Provides the RIM functionatlity. More...

#include "RIM/rim.h"
#include "data_p.h"
#include "descriptions.ic"
#include "AG_initRIM_p.h"
#include "AG_regEnums_s.h"
#include "PBI/Endianness.h"
#include <string.h>

Include dependency graph for rim.c:

Enumerations
enum	{   TRC_CSR_ZERO_H = 0x00000003,   TRC_CSR_ZERO_L = 0xa0000000 }
Functions
size_t	sizeofStore (void)
	Calculate the "payload" of RIM.
size_t	roundUp (size_t size)
	Round up a buffer size to be 64 bit aligned.
char *	align (char *next)
	Align a pointer to the next 64-bit aligned block.
size_t	RIM_sizeof (void)
	Calculate the footprint of the RIM structure.
RIM *	RIM_construct (void *buffer)
	Initialised a block of memory as a RIM object.
void	RIM_clear (RIM *rim)
	Clear out the map and data portions of the RIM structure.

---

Detailed Description

Provides the RIM functionatlity.

Author:

James Swain -- jswain@slac.stanford.edu

---

Function Documentation

char * align (  char *  next  )

Align a pointer to the next 64-bit aligned block. Parameters: next  Ptr to the next data block Returns: Pointer to the next 64-bit aligned block

void RIM_clear (  RIM *  rim  )

Clear out the map and data portions of the RIM structure. Parameters: rim  Pointer to the RIM object to clear

RIM* RIM_construct (  void *  buffer  )

Initialised a block of memory as a RIM object. Parameters: buffer  Pointer to uninitialised memory to use for the RIM structure Returns: NULL if the buffer is misaligned, or an initialised RIM structure

size_t RIM_sizeof (  void   )

Calculate the footprint of the RIM structure. Returns: Amount of memory required to hold the RIM structure

size_t roundUp (  size_t  size  )

Round up a buffer size to be 64 bit aligned. Parameters: size  Unrounded size Returns: Rounded size

size_t sizeofStore (  void   )

Calculate the "payload" of RIM. Returns: Amount of memory required to hold the RIM storage

---