addr.h File Reference

Functions converting flat index to/from hierarchical addressing. More...

#include <LATC/lrd.h>

Functions
void	LATC_layerLow (const Layer_addr *layer, TEM_addr *tem)
	Convert the conceptual layer addressing of a TFE to the hierarchical form used to communicate with the LAT.
void	LATC_layerHigh (const Layer_addr *layer, TEM_addr *tem)
	Convert the conceptual layer addressing of a TFE to the hierarchical form used to communicate with the LAT.
unsigned	LATC_getAddress (LATC_addr *addr, unsigned index, LATC_type type)
	Convert hierarchical bit addressing to flat addressing.
unsigned	LATC_getIndex (const LATC_addr *addr, unsigned *index, LATC_type type)
	Convert hierarchical bit addressing to flat addressing.

---

Detailed Description

Functions converting flat index to/from hierarchical addressing.

Author:

James Swain -- jswain@slac.stanford.edu

---

Function Documentation

unsigned LATC_getAddress	(	LATC_addr *	addr,
		unsigned	index,
		LATC_type	type
	)

Convert hierarchical bit addressing to flat addressing.

Parameters:

	addr	Address to convert
	type	Type of address to conver
	index	Index corresponding to address

Returns:

One of LATC_ERR, LATC_OK on succes Note that GTFEs are usually referred to as being part of an X or Y layer. This identification is converted to an absolute layer number and stored in the rc space by addr->rc = (layerNumber << 1) | isYlayer. This conversion is performed by the XLM->LATC converter, but is documented here since it is a storage convention.

References LATC_addr::cpt.

Referenced by LATC_contrast().

unsigned LATC_getIndex	(	const LATC_addr *	addr,
		unsigned *	index,
		LATC_type	type
	)

Convert hierarchical bit addressing to flat addressing.

Parameters:

	addr	Address to convert
	type	Type of address to conver
	index	Index corresponding to address

Return values:

	LATC_SUCCESS	if the address is successfully converted to an index
	LATC_BADBCAST	if the address contains a mixture of broadcast and unicast components
	LATC_BADADDR	if any component of the address is outside the allowable range for this type Note that GTFEs are usually referred to as being part of an X or Y layer. This identification is converted to an absolute layer number and stored in the rc space by addr->rc = (layerNumber << 1) | isYlayer. This conversion is performed by the XLM->LATC converter, but is documented here since it is a storage convention.

References LATC_addr::cpt.

Referenced by LATC_deleteData(), LATC_get(), LATC_set(), mapIndex(), and mapRange().

void LATC_layerHigh	(	const Layer_addr *	layer,
		TEM_addr *	tem
	)

Convert the conceptual layer addressing of a TFE to the hierarchical form used to communicate with the LAT.

Parameters:

	layer	Address of the TFE / SPT in terms of layers
	tem	Address of the TFE / TRC in terms of CC/RC Note that TFEs are usually referred to as being part of an X or Y layer. This identification is converted to an absolute layer number and stored in the rc space by addr->rc = (layerNumber << 1) | isYlayer. This conversion is performed by the XLM->LATC converter, but is documented here since it is a storage convention.

References TEM_addr::cc, Layer_addr::fe, TEM_addr::fe, Layer_addr::la, TEM_addr::rc, tcc_lkup, Layer_addr::to, and TEM_addr::to.

void LATC_layerLow	(	const Layer_addr *	layer,
		TEM_addr *	tem
	)

Convert the conceptual layer addressing of a TFE to the hierarchical form used to communicate with the LAT.

Parameters:

	layer	Address of the TFE / SPT in terms of layers
	tem	Address of the TFE / TRC in terms of CC/RC Note that TFEs are usually referred to as being part of an X or Y layer. This identification is converted to an absolute layer number and stored in the rc space by addr->rc = (layerNumber << 1) | isYlayer. This conversion is performed by the XLM->LATC converter, but is documented here since it is a storage convention.

References TEM_addr::cc, Layer_addr::fe, TEM_addr::fe, Layer_addr::la, TEM_addr::rc, tcc_lkup, Layer_addr::to, and TEM_addr::to.