rpp/blocks/sfunction_sdrw.c

   1 /* Copyright (C) 2013, 2014 Czech Technical University in Prague
   2  *
   3  * Authors:
   4  *     - Carlos Jenkins <carlos@jenkins.co.cr>
   5  *
   6  * This document contains proprietary information belonging to Czech
   7  * Technical University in Prague. Passing on and copying of this
   8  * document, and communication of its contents is not permitted
   9  * without prior written authorization.
  10  *
  11  * File : sfunction_sdrw.c
  12  * Abstract:
  13  *     C-MEX S-function block for RPP SD-RAM log write.
  14  *
  15  * References:
  16  *     header.c
  17  *     trailer.c
  18  *
  19  * Compile with:
  20  *     <matlabroot>/bin/mex sfunction_sdrw.c
  21  */
  22
  23 /*
  24 %YAML 1.2
  25 ---
  26 Name: SD-RAM Log Data
  27 Category: Logging
  28 Header: rpp/sdc.h
  29 Mnemonic: SDRW
  30
  31 Inputs:
  32   - { name: "Data", type: "double" }
  33
  34 Outputs:
  35   - { name: "ErrFlag", type: "bool" }
  36
  37 Parameters:
  38   - { name: "Block ID",              type: "uint8", range: "[0-255]" }
  39   - { name: "Printf format for logging", type: "string", range: "(include specifiers)" }
  40
  41 # Description and Help is in Markdown mark-up
  42 Description: &desc |
  43
  44   This block allows to log a double value to the SD-RAM. User needs to provide a valid PrintFormat
  45   string to format and register the double value on the log. The PrintFormat string should include
  46   two specifiers:
  47     1. For the block ID. Any valid integer specifier.
  48     2. For the value to log. Any valid double specifier.
  49
  50   Note that the value of PrintFormat is inserted raw between quotes on code generation and thus there
  51   is no validation on it. Error to provide a valid PrintFormat could generate compilation errors or
  52   even run-time errors (normally this generates a warning on compile time). Note that the function
  53   for logging used is `rpp_sdr_printf()`, which is a blocking call, and can potentially overrun the
  54   step. The ErrFlag will set if `rpp_sdr_printf()` returns an error (for example out of memory),
  55   but will clear back if the next step the call to this function is successful.
  56
  57 Help: *desc
  58
  59 Status: Beta
  60
  61 RPP API functions used:
  62     - rpp_sdr_printf()
  63
  64 Relevant demos:
  65     - log_analog_input
  66 ...
  67 */
  68
  69 #define S_FUNCTION_NAME sfunction_sdrw
  70 #include "header.c"
  71
  72
  73 static void mdlInitializeSizes(SimStruct *S)
  74 {
  75     /*
  76      * Configure parameters: 2
  77      *  - Block ID.
  78      *  - Printf format [setting].
  79      */
  80     if (!rppSetNumParams(S, 2)) {
  81         return;
  82     }
  83
  84     /*
  85      * Configure input ports: 1
  86      *  - Data.
  87      */
  88     if (!ssSetNumInputPorts(S, 1)) {
  89         return;
  90     }
  91     rppAddInputPort(S, 0, SS_DOUBLE);
  92
  93     /*
  94      * Configure output ports: 1
  95      *  - Error flag.
  96      */
  97     if (!ssSetNumOutputPorts(S, 1)) {
  98         return;
  99     }
 100     rppAddOutputPort(S, 0, SS_BOOLEAN);
 101
 102     /* Set standard options for this block */
 103     rppSetStandardOptions(S);
 104 }
 105
 106
 107 #ifdef MATLAB_MEX_FILE
 108 #define MDL_CHECK_PARAMETERS
 109 static void mdlCheckParameters(SimStruct *S)
 110 {
 111     /* Check the parameter 1 */
 112     if (!rppValidParamRange(S, 0, 0, 255)) {
 113         return;
 114     }
 115 }
 116 #endif
 117
 118
 119 #ifdef MATLAB_MEX_FILE
 120 #define MDL_SET_WORK_WIDTHS
 121 static void mdlSetWorkWidths(SimStruct *S)
 122 {
 123     /* Set number of run-time parameters */
 124     if (!ssSetNumRunTimeParams(S, 1)) {
 125         return;
 126     }
 127
 128     /* Register the run-time parameter 1 */
 129     ssRegDlgParamAsRunTimeParam(S, 0, 0, "p1", SS_UINT8);
 130 }
 131 #endif
 132
 133
 134 #ifdef MATLAB_MEX_FILE
 135 #define MDL_RTW
 136 static void mdlRTW(SimStruct* S)
 137 {
 138     /* Register parameter 2 as a parameter setting */
 139     static char_T str[128];
 140     mxGetString(ssGetSFcnParam(S, 1), (char*)&str, sizeof(str)); /* Get string */
 141     if (!ssWriteRTWParamSettings(S, 1,
 142             SSWRITE_VALUE_QSTR, "PrintfFormat", (const char_T*)&str)) {
 143         /* An error ocurred */
 144         return;
 145     }
 146 }
 147 #endif
 148
 149
 150 #define COMMON_MDLINITIALIZESAMPLETIMES_INHERIT
 151 #define UNUSED_MDLOUTPUTS
 152 #define UNUSED_MDLTERMINATE
 153 #include "trailer.c"