kobanzame.h File Reference

KOBANZAME SDK Standard Include file. More...

#include "target_def.h"
#include "kzconfig.h"
#include "kernel.h"
#include <stdio.h>
#include "kzstdio.h"
#include "kzdev.h"
#include "kzdsp.h"
#include "kzprivate.h"
Include dependency graph for kobanzame.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  KzCmdRegist_t

Defines

#define numof(x)   sizeof(x)/sizeof(x[0])
#define KZ_AUDIOCLUSTAR   (4)
 Numbers of the Audio Clustar, Audio Clustar Order is L0/R0/L1/R1.
#define L1DATA_S   section("L1_data_s")
 Memory section directive: L1 SCRATCH.
#define L1DATA_A   section("L1_data_a")
 Memory section directive: L1 DATA A.
#define L1DATA_B   section("L1_data_b")
 Memory section directive: L1 DATA B.
#define L1CODE   section("L1_code")
 Memory section directive: L1 CODE.
#define L3DATA   section("L3_data")
 Memory section directive: SDRAM DATA.
#define L3CODE   section("L3_code")
 Memory section directive: SDRAM CODE.

Typedefs

typedef int(* KzFnCmd_t )(int argc, char *argv[])
 command line function's type
typedef void(* KzSwCbk_t )(KzSW_t nSw, BOOL bPushed)
 callback type for physical switches change status
typedef void(* KzMemsCbk_t )(int x, int y, int z)
 callback function type for MEMS changes
typedef void(* KzAudioCbk_t )(int *in, int *out, int nBlocks, int nChannels)
 callback function type for audio

Enumerations

enum  KzSW_t { eKzSW0, eKzSW1, numof_KzSW }
enum  KzLED_t { eKzLED0, eKzLED1, numof_KzLED }
enum  KZSTATUS_t { KZ_OK = 0, KZ_ERR = -1 }

Functions

KZSTATUS_t KzCmdlineStart (void)
 Command Line Start.
KZSTATUS_t KzCmdlineExit (void)
 Command Line Exit.
KZSTATUS_t KzCmdlineAdd (const KzCmdRegist_t *exe)
 Add a Command.
KZSTATUS_t KzCmdlineAddMany (const KzCmdRegist_t *exes)
 Add Many Commands.
KZSTATUS_t KzAddCmdDeviceDriver (void)
 Add DeviceDriver commands.
KZSTATUS_t KzSwStart (KzSwCbk_t cbk)
 Swith start.
KZSTATUS_t KzSwStop (void)
 Swith stop.
KZSTATUS_t KzLedOn (KzLED_t nLedNo)
 Set LED ON.
KZSTATUS_t KzLedOff (KzLED_t nLedNo)
 Set LED OFF.
KZSTATUS_t KzLedBlink (KzLED_t nLedNo, int nOnTime, int nOffTime)
 Set LED blink.
KZSTATUS_t KzMemsStart (KzMemsCbk_t cbk)
 MEMS start.
KZSTATUS_t KzMemsStop (void)
 MEMS stop.
KZSTATUS_t KzAudioStart (KzAudioCbk_t cbk, long lSampleRate, int nBlocks, int nChannels)
 Audio start.
KZSTATUS_t KzAudioStop (void)
 Audio stop.
int KzGetVersionMajor (void)
 Get KOBANZAME SDK Major Version.
int KzGetVersionMinor (void)
 Get KOBANZAME SDK Minor Version.
int KzGetBuildIdx (void)
 Get KOBANZAME SDK Build index.
const char * KzGetBuildDate (void)
 Get KOBANZAME SDK Build Date String.
const char * KzGetCopyRight (void)
 Get KOBANZAME SDK Copyright String.
KZSTATUS_t KzFilesystemStart (void)
 Filesystem start.
KZSTATUS_t KzAddCmdFilesystem (void)
 Add Filesystem commands.
KZSTATUS_t KzAddCmdStdioTest (void)
 Add stdio test commands.

Detailed Description

KOBANZAME SDK Standard Include file.

KOBANZAME SDK Software Developers Kit for Blackfin DSP Evaluation Board(KOBANZAME).

Copyright (C) 2010, KOBANZAME SDK Project, all right reserved

LICENSE: The software is a free and you can use and redistribute it for personal, non-profit or commercial products. Redistributions of source code must retain the above copyright notice. There is no warranty in this software, if you suffer any damages by using the software.

Note:
KOBANZAME SDK Common include file

Define Documentation

#define numof (  )     sizeof(x)/sizeof(x[0])

number of the contents


Typedef Documentation

callback function type for audio

Parameters:
in audio input buffer from Audio Codec
out audio output buffer to Audio Codec
nBlocks number of the Audio blocks
nChannels numober of the Audio Channels (1-4)
Note:
in and out buffer is clustared as L0/R0/L1/R1

command line function's type

Parameters:
argc number of the arguments from command line
argv argument strings

callback function type for MEMS changes

Parameters:
x MEMS X value
y MEMS Y value
z MEMS Z value

callback type for physical switches change status

Parameters:
nSw KOBANZAME hardware switch ID
bPushed TRUE ... Pushed / FALSE ... Released

Enumeration Type Documentation

enum KzLED_t

definition for LEDs

Enumerator:
eKzLED0 

KOBANZAME hardware LED 0

eKzLED1 

KOBANZAME hardware LED 1

numof_KzLED 

number of the LEDs of KOBANZAME

enum KZSTATUS_t

KOBANZAME SDK's general return type

Enumerator:
KZ_OK 

Success

KZ_ERR 

Error

enum KzSW_t

physical switches type

Enumerator:
eKzSW0 

KOBANZAME hardware switch 0

eKzSW1 

KOBANZAME hardware switch 1

numof_KzSW 

number of the physical switches


Function Documentation

KZSTATUS_t KzAddCmdStdioTest ( void   ) 

Add stdio test commands.

Returns:
KZ_OK Success
Lack of memory space for the command. See KzCmdlineAddMany
Note:
After this function call. User can use following commands.
  • puts
  • gets
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated by  doxygen 1.6.2