# Tcp3d_MemBuffer Struct Reference
[TCP3D Driver Data Structures]

Memory Buffer Structure. More...

`#include <tcp3d_drv.h>`

## Data Fields

Tcp3d_BufClass | mclass
uint16_t | log2align
uint32_t | size
uint16_t | volat
void * | base

## Detailed Description

Memory Buffer Structure.

This structure is used to request and/or supply the dynamic memory to the components.

## Field Documentation

void* Tcp3d_MemBuffer::base

Base address of the requested buffer.

uint16_t Tcp3d_MemBuffer::log2align

Alignment information (>= 0). If zero, no alignment is required nor provided. Otherwise, memory buffer is aligned on appropriate power of 2 (e.g. if log2align=3, buffer is aligned modulo-8).

Tcp3d_BufClass Tcp3d_MemBuffer::mclass

Memory class. It is used to describe kind of memory that is requested or returned. For example: external, internal, or similar. One should use MEM_CLASS_xxx constants. On RETURN, class may be changed if original memory class is exhausted.

uint32_t Tcp3d_MemBuffer::size

Number of 8 bit words that are requested or supplied. Word length depends on the platform, and corresponds to the shortest element that can be addressed by the CPU. Word storage length in bits is defined in types.h as TYP_TWORD_SIZE. The maximum size depends on the platform.

uint16_t Tcp3d_MemBuffer::volat

TRUE: Memory buffer must be restored before and saved after it is used. FALSE: Save/restore are not necessary. On RETURN, volatile flag may be changed if original request could not be satisfied.

The documentation for this struct was generated from the following file:

- tcp3d_drv.h

Copyright 2012, Texas Instruments Incorporated