Motorola DSP Developer's Kit

Motorola DSP MEX-File Programming Reference

Public Methods

This is a list of publicly available C++ method prototypes that you may include in your DSP MEX-files.

class MOTDSP_Exception.   

    MOTDSP_Exception(const char* error_message, 
                   const int error_number = EEX_UNKNOWN);

class MOTDSP_FuncVar.   

    MOTDSP_FuncVar(int nrhs, int nlhs);
    int GetSize(void);
    int GetSizeReal(void);
    int GetSizeImag(void);
    int GetNumRows(void);
    int GetNumCols(void);
    enum mat_type GetType(void);
    bool IsComplex(void);
    bool Isnormalized(double value);
    void SetSize(int rows, int columns);

class MOTDSP_Input : public MOTDSP_FuncVar.   

    MOTDSP_Input(int arg_index, const mxArray* arg_pointer[], 
                 enum inp_type);
    MOTDSP_Input(int arg_index, const mxArray* arg_pointer[], 
                 const char* arg_options[], int num_arg_options, 
                 enum inp_type);
    int GetIndex(void);
    double* GetData(void);  
    double* GetDataReal(void);
    double* GetDataImag(void);
    double* GetDataComplex(void);
    double* GetData(int row, int col);
    double* GetDataReal(int row, int col);
    double* GetDataImag(int row, int col);

class MOTDSP_Output: public MOTDSP_FuncVar.   

    MOTDSP_Output(int arg_index,
                mxArray* arg_pointer[],
                enum mat_type m_type);
    void SetSize(mxArray* arg_pointer[],
               int rows,
               int cols);
    int GetIndex(void);
    void PutData(double *data);
    void PutDataReal(double *data);
    void PutDataImag(double *data);
    void PutDataComplex(double *data);
    void PutData(double value);
    void PutDataReal(double value);
    void PutDataImag(double value);
    void PutDataComplex(double value);

class MOTDSP_Simulator.   

    char* GetMexFuncName(void);
    char* GetObjectFileName(void);
    char* GetDeviceType(void);
    char* GetCommandFile(void);
    int GetDeviceNumber(void);

class MOTDSP_IssCustom : public MOTDSP_Simulator .   

    MOTDSP_IssCustom(const char* MEX_function_name, 
                     const char* object_code_file,
                     const char* processor_type,
                     const char* sim_command_file);
    ulong ConvertDoubleToFixed(double dval);
    double ConvertFixedToDouble(ulong fixval);
    bool DoCommand(const char* command);
    ulong GetSymbolAddress(const char *symbol_name);
    enum memory_map GetSymbolMemMap(const char *symbol_name);
    double* ReadFromDspMem(const char* symbol_name, 
                      int block_size,
                      enum sim_radix_type radix_type );
    double* ReadFromDspMem(enum memory_map map, 
                           ulong mem_address,
                           int block_size,
                           enum sim_radix_type radix_type );

    ulong* ReadFromDspMemInt(enum memory_map map, 
                             ulong mem_address,
                             int block_size );
    double* ReadFromDspMemFrac(enum memory_map map, 
                               ulong mem_address,
                             int block_size );
    double* ReadFromDspReg(const char* reg_name, 
                           enum sim_radix_type radix_type);
    void Run(void);
    void Terminate(void);
    void WriteToDspMem(const char* symbol_name,
                       double* data, 
                       int block_size);
    void WriteToDspMem(enum memory_map map, 
                       ulong mem_address, 
                       double* data,
                       int block_size);
    void WriteToDspMem(const char* symbol_name, 
                       ulong* data, 
                       int block_size);

    void WriteToDspMem(enum memory_map map, 
                       ulong mem_address, 
                       ulong* data, 
                       int block_size);
    void WriteToDspReg(const char* reg_name, ulong value);
    void WriteToDspReg(const char* reg_name, double value);
    void WriteToDspReg(const char* reg_name, ulong* value);
    void WriteToDspReg(const char* reg_name, double* value);

class MOTDSP_IssStandAlone : public MOTDSP_Simulator.   

    MOTDSP_IssStandAlone(const char* MEX_function_name, 
                         const char* object_code_file,
                         const char* processor_type, 
                         const char* sim_command_file);
    void AddSnapShot(const char* var_name, char* reg_name);
    void AddSnapShot(const char* var_name, 
                     enum memory_map map, 
                     ulong address, 
                     int block_size);
    ulong GetSymbolAddress(const char *symbol_name);
    enum memory_map GetSymbolMemMap(const char *symbol_name);
    double* ReadFromDspMem(const char* symbol_name, 
                           int block_size,
                           enum sim_radix_type radix_type );
    double* ReadFromDspMem(enum memory_map map, 
                           ulong mem_address,
                           int block_size,
                           enum sim_radix_type radix_type );
    ulong* ReadFromDspMemInt(enum memory_map map, 
                             ulong mem_address,
                             int block_size );
    double* ReadFromDspMemFrac(enum memory_map map, 
                               ulong mem_address, 
                               int block_size );
    double* ReadFromDspReg(const char* reg_name, 
                          enum sim_radix_type radix_type);
    void Run(void);
    void Terminate(void);
    void WriteToDspMem(const char* symbol_name, 
                       double* data, 
                       int block_size);
    void WriteToDspMem(enum memory_map map, 
                       ulong mem_address, 
                       double* data, 
                       int block_size);
    void WriteToDspMem(const char* symbol_name, 
                       ulong* data, 
                       int block_size);
    void WriteToDspMem(enum memory_map map, 
                       ulong mem_address, 
                       ulong* data, 
                       int block_size);
    void WriteToDspReg(const char* reg_name, ulong value);
    void WriteToDspReg(const char* reg_name, double value);
    void WriteToDspReg(const char* reg_name, ulong* value);
    void WriteToDspReg(const char* reg_name, double* value);

class MOTDSP_Config.   

    MOTDSP_Config(int argc_input, 
                  int argc_output,
                  const mxArray* prhs[]);
    char* GetCommandFile(void);
    char* GetProcessorType(void);
    int GetDspFamilyType(void);
    int GetFixedInputs( void);

Reference

Macros