Doxygen Documentation
	Main Index	Package Index
	Package:	PBI
	Version:	V0-0-3	Marked:	(not marked)
	Constituent:	doc_gather	Tag:	sun-gcc

---

         

---

TBD_id.h File Reference

Enumerates the usage of the TBD data array. More...

This graph shows which files directly or indirectly include this file:

Typedefs
typedef enum _TBD_id	TBD_id
	Typedef for enum _TBD_id.
Enumerations
enum	_TBD_id {   TBD_K_ID_TCB = 0,   TBD_K_ID_MSG = 1 }
	Enumerates the use of the TBD data base. More...

---

Detailed Description

Enumerates the usage of the TBD data array.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id
   

In order to minimize the number of task specific global variables that needs to be managed on each task switch, the address of one array of (at the time of this writing) 32 data words (void *'s) is all that is switched. This array is managed by the TBD facility.

This file is not meant to be included in user code. It serves only as a nexus for documention. When a new TBD id is needed, it should be registered in this file. The nature of TBD is such that the actual id is more than likely used privately within a single facility. The user can easily arrange to #define the variable. Having a file that defines all such ids and is included by all such clients only serves to make the build system jumpy. What is really needed is just a place to document usage.

The suggested for is TBD_K_ID_xxx, where xxx is a short descriptive acryonmn for the entry. This is only a suggestion, but it will allow one to search the source code for all such usages.

---

Typedef Documentation

TBD_id

Typedef for enum _TBD_id. Currently there are a maximum of 32 such ids.

---

Enumeration Type Documentation

enum _TBD_id

Enumerates the use of the TBD data base. Enumeration values: TBD_K_ID_TCB  Task TCB TBD_K_ID_MSG  Message facility

---