Driver Usage - Freescale Semiconductor DSP56800E User Manual

FreeMASTER Driver
6.6

Driver Usage

The FreeMASTER driver was designed to be easily used in any DSP56F800E_Quick_Start
application and also in custom user code. With DSP56F800E_Quick_Start, the following steps
are necessary to enable a basic FreeMASTER connectivity in the application:
• The FreeMASTER driver needs to be configured in the Graphical Configuration Tool or in the
appconfig.h file directly.
• The freemaster.h file needs to be included in any application source file which makes
FreeMASTER API calls.
• The FMSTR_Init() function has to be called before any other FreeMASTER driver API calls.
• For FMSTR_LONG_INTR or FMSTR_SHORT_INTR modes, the SCI or JTAG interrupts need
to be directed to FMSTR_Isr() function. This is done automatically when the FreeMASTER driver
is configured using the Graphical Configuration Tool.
The interrupt priority levels need to be set (in GCT) and the interrupts have to be enabled in the
processor core (archEnableInt()).
• For FMSTR_SHORT_INTR or FMSTR_POLL_DRIVEN modes, the FMSTR_Poll() API
function needs to be called periodically in the application. For example in the application main loop.
See Driver API description in the next section for more detail on how to use advanced
FreeMASTER features like Application Commands, Recorder or TSA.
6.6.1 Driver API
This section describes the FreeMASTER driver API. It can be expected the same API will be used
with the new FreeMASTER driver on other Freescale platforms as well.
The following header files are needed in order to use the FreeMASTER driver:
Required Header File(s):
#include "qs.h"
#include "freemaster.h"
The next sections describe each driver API function in detail. Function arguments for each routine
are described as in or out
1. in argument means that the parameter value is an input only to the function.
2. out argument means that the parameter value is an output only from the function.
6-10 Targeting 56F8xxx Platform FREESCALE SEMICONDUCTOR