Contents

API Function Reference

Macro, Constant and Type Reference

Header File Reference

Communication protocol between Host and Dsp (DspIoctl.h)

DSP SDK Host .. DSP Macro, Constant and Type Reference

Example

The IO Control codes used (from Host towards the DSP code) are
16 bit values layed out as follows:


 1 1 1 1 1 1
 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0

|S|C|P|         Code            |

S - SDK System IO Codes - reserved

    1 - SDK Reserved System Codes

    0 - User application code

C - Data Complete - reserved

    0 - There is more data pending for this IO Code

    1 - Data is complete for this IO Code.

P - Padded octet for Data

    0 - Even number of octets were transferred. Data length (in words)
	reflects actual number of data octets transferred (2*octets).

    1 - Odd number of octets were transferred. Data length includes one
	padded octet.

Code - is the IO Control code value

1. Retrieve (and possibly process) the data passed in the IO packet.
2. Writing return data (if any) to OTXDSP_SDK_IOCTL_DATA_ADDR and data
   length OTXDSP_SDK_IOCTL_DATA_LEN_ADDR.
3. Mark the completion of the packet by writing OTXDSP_SDK_IO_NO_COMMAND
   to the OTXDSP_SDK_IOCTL_CODE_ADDR.
4. Issue an interrupt towards the host.

1 1 1 1 1 1
5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0

|           IO Code             |  OTXDSP_SDK_IOCTL_CODE_ADDR

|  LogDevType   |  Handle       |  OTXDSP_SDK_IOCTL_HANDLE_ADDR

|           Task Ref            |  OTXDSP_SDK_IOCTL_TASKREF_ADDR

|           Data Length (n)     |  OTXDSP_SDK_IOCTL_DATA_LEN_ADDR

|           Data Word 0         |  OTXDSP_SDK_IOCTL_DATA_ADDR

|           Data Word 1         |

:                               :

|           Data Word (n-1)     |

1 1 1 1 1 1
5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0

|           Processing Addr     |       OTXDSP_SDK_EVENT_BUF_PROCESSING_ADDR

|S|C|P|     Event Code          |  >-+  OTXDSP_SDK_EVENT_BUF_ADDR (start of buffer)
|
|  LogDevType   |  Handle       |    |
|
|           TaskRef             |    |
|
|           TimeStamp bit 48-63 |    |
|
|           TimeStamp bit 32-47 |    |
|
|           TimeStamp bit 16-31 |    |
|
|           TimeStamp bit  0-15 |    |
|
|           Data Length (n=0)   |    |
|
|S|C|P|     Event Code          |    |
|
|  LogDevType   |  Handle       |    |
|
|           TaskRef             |    |
|
|           TimeStamp bit 48-63 |    |
|
|           TimeStamp bit 32-47 |    |
|
|           TimeStamp bit 16-31 |    |
|
|           TimeStamp bit  0-15 |    |
|
|           Data Length (n=2)   |    |
|
|           Data Word 0         |    |
|
|           Data Word 1         |    |
|
|  OTXDSP_SDK_EVENT_NO_COMMAND  |    |
|
:                               :    |
|
|                               |  <-+  End of Event buffer


*/ /*

DSP SDK Constants, Macros, and Types (Dsp54Def.h)

DSP C54x SDK Macro, Constant, and Type Reference

DSP SDK Functions (Dsp54Api.h)

Dsp54Api Function Reference

Dsp54Api.h

Dsp54Def.h

Dsp54Ioctl.h

DspIoctl.h

Description

Description

Description

Description

Parameters

lawCompInput

14 bit 2-s complement value to be companded

Comments

Parameters

void

No parameters

Parameters

hHandle

Handle to the user defined logical device

Parameters

hHandle

Handle to the user logical device

pData

Pointer to the data to be returned to the host driver

dataLen

Length of the data to be returned to the host driver

Parameters

hHandle

Handle to the user defined logical device

nResult

Result code to be passed to the host driver

Parameters

void

No parameters

See Also

Parameters

intmVal

INTM value returned by OtxDspCriticalSectionBegin

See Also

Parameters

void

No parameters

Parameters

void

No parameters

Parameters

void

No parameters

Parameters

void

No parameters

Parameters

valueIMR

Interrupts to be unmasked

Parameters

void

No parameters

This function should be called when the OTXDSP_SDK_IO_INIT_TIMER IO code is sent from the host.
Defined in: Dsp54Api.h

Parameters

void

No parameters

Parameters

lawExpandInput

Sample to be expanded (8-bits sign magnitude value

law

Law (0 = u-law, 1 = A-law)

Comments

Parameters

void

No parameters

Parameters

void

No parameters

Comments

Parameters

void

No parameters

Comments

Parameters

void

No parameters

Comments

Parameters

nEvent

Event to be send to the host

hHandle

Handle to the user logical device sending the event

nTaskRef

Associated Task Reference

pData

Pointer to the data to be sent to the host

nDataLen

Length of the data to be sent

Extended version. Has the ability to transfer a buffer of octets as well as a buffer of words.
Defined in: Dsp54Api.h

Parameters

nEvent

Event to be send to the host

hHandle

Handle to the user logical device sending the event

nTaskRef

Associated Task Reference

pData

Pointer to the data to be sent to the host

nDataLen

Length of the data to be sent

bOctetTransfer

OTXDSP_TRUE if nDataLen and pData specifies octets. OTXDSP_FALSE if they specify words

Parameters

nEvent

Event to be send to the host

hHandle

Handle to the user logical device sending the event

data

Data to be sent to the host

Parameters

nEvent

Event to be send to the host

hHandle

Handle to the user logical device sending the event

data

Data to be sent to the host

Parameters

nEvent

Event to be send to the host

hHandle

Handle to the user logical device sending the event

This function should be called when the OTXDSP_SDK_IO_START_PROGRAM IO code is sent from the host.
Defined in: Dsp54Api.h

Parameters

pSin

returned inforamtion from host

See Also

Parameters

lawCompInput

14 bit 2-s complement value to be companded

Comments

Members

cwFreeBuffer

Current number of free words in the HPI Event Buffer

cwMinFreeBuffer

Minimum number of free words in the HPI Event Buffer since the application started

coLostEvents

Number of lost event packets (due to a full buffer) since the application started

Developer Notes

struct {
	short nDirection;
	short nCapacity;
	unsigned short sqConnectMask[OTXDSP_SDK_MAX_TIMESLOTS/2];
	unsigned short coMaskSize;
	unsigned short hPipeHandleLowPart;
	unsigned short hPipeHandleHighPart;
} OtxDspSdkIoInConnectS;

Members

nDirection

Either OTXDSP_SDK_RX_DIRECTION or OTXDSP_SDK_TX_DIRECTION

nCapacity

Pipe capacity in kbytes/s

sqConnectMask[OTXDSP_SDK_MAX_TIMESLOTS/2]

Timeslots to connect to on the DSP Highway

coMaskSize

Actual number of timeslots used in sqConnectMask

hPipeHandleLowPart

Lower 16 bits of the host's handle for this pipe

hPipeHandleHighPart

Upper 16 bits of the host's handle for this pipe

struct {
	short nDirection;
	short nCapacity;
	unsigned short sqConnectMask[OTXDSP_SDK_MAX_TIMESLOTS/2];
	unsigned short coMaskSize;
	unsigned short hPipeHandleLowPart;
	unsigned short hPipeHandleHighPart;
} OtxDspSdkIoInDisconnectS;

Members

nDirection

Either OTXDSP_SDK_RX_DIRECTION or OTXDSP_SDK_TX_DIRECTION

nCapacity

Pipe capacity in kbytes/s

sqConnectMask[OTXDSP_SDK_MAX_TIMESLOTS/2]

Timeslots to connect to on the DSP Highway

coMaskSize

Actual number of timeslots used in sqConnectMask

hPipeHandleLowPart

Lower 16 bits of the host's handle for this pipe

hPipeHandleHighPart

Upper 16 bits of the host's handle for this pipe

struct {
	unsigned short nClkMdVal;
	unsigned short nHighwaySpeed;
	unsigned short nDrvRevNoMajor;
	unsigned short nDrvRevNoMinor;
	unsigned short nDrvRevNoPr;
	unsigned short nDrvRevNoPversion;
	unsigned short nReserved0;
	unsigned short nReserved1;
	unsigned short nReserved2;
	unsigned short nReserved3;
	unsigned short nReserved4;
	unsigned short nReserved5;
	unsigned short nReserved6;
	unsigned short nReserved7;
} OtxDspSdkIoInStartProgramS;

Members

nClkMdVal

The PLLMUL, PLLDIV, and PLLCOUNT bits of the Clock Mode Register

nHighwaySpeed

DSP Serial port highway speed in kbps (2048, 4096, or 8192 kpbs)

nDrvRevNoMajor

Driver Revision; Major

nDrvRevNoMinor

Driver Revision; Minor

nDrvRevNoPr

Driver Revision; PR (PR = 0 = Preliminary, PR = 1 = Release, If PR = 1 P-Version is always 0)

nDrvRevNoPversion

Driver Revision; P-Version: (Only valid if PR = 0)

nReserved0

Reserved for future use

nReserved1

Reserved for future use

nReserved2

Reserved for future use

nReserved3

Reserved for future use

nReserved4

Reserved for future use

nReserved5

Reserved for future use

nReserved6

Reserved for future use

nReserved7

Reserved for future use

struct {
	unsigned short nResult;
} OtxDspSdkIoOutResultS;

Members

nResult

DSP Application return code