{{{#!comment
[[Include(wiki:802.11/beta-note)]]
}}}

[[TracNav(802.11/TOC)]]

= 802.11 Reference Design:  Event Log Entry Types = 

The 802.11 Reference Design logging framework is designed to record log entries of arbitrary length and type. The MAC code in CPU High is responsible for defining the log entry types and populating each log entry at run time.

The reference code for CPU High defines a number of useful log entry types and implements logging of many run time events, including all Tx and Rx activity. The entry types defined in the reference implementation are listed below.

Users can define new log entry types or modify existing types to support their experiment. The requirements for this are documented below.

== Reference Design Entry Types ==
The sections below document the log entry types defined in the latest 802.11 Reference Design C and Python code.

This listing is generated directly from the [source:/ReferenceDesigns/w3_802.11/python/wlan_exp/log/entry_types.py entry_types.py] file in the wlan_exp Python package. You can generate a text version of the entry type list with this code:
{{{#!python
from wlan_exp.log.entry_types import log_entry_types as log_entry_types

for tid in log_entry_types.keys():
    if(type(tid) is int and tid != 0): #only take int type IDs and skip NULL
        print(log_entry_types[tid].generate_entry_doc(fmt='txt'))
}}}


{{{#!comment
Note to selves:

The list of entry types is drawn directly from svn. To update the docs:
 1) Update the entry type description and entry field descriptions in wlan_exp/log/entry_types.py
 2) CD to wlan_exp/log/
 3) Run 'python gen_entry_type_wiki_docs.py > entry_type_wiki_docs.txt'
 4) svn commit the changes; the .py and .txt should always be committed together

}}}

----

[[Include(source:/ReferenceDesigns/w3_802.11/python/wlan_exp/log/entry_type_wiki_docs.txt,  text/x-trac-wiki)]]