runtime.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/tflmrt/runtime.h
 *
 *   Copyright 2021 Sony Semiconductor Solutions Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Sony Semiconductor Solutions Corporation nor
 *    the names of its contributors may be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
 
#ifndef __MODULES_INCLUDE_TFLMRT_RUNTIME_H
#define __MODULES_INCLUDE_TFLMRT_RUNTIME_H
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
#define TF_LITE_STATIC_MEMORY
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <asmp/types.h>
 
#include "tensorflow/lite/c/common.h"
#include "tensorflow/lite/micro/spresense/debug_log_callback.h"
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
 
typedef struct tflm_runtime
{
  void *impl_ctx;
} tflm_runtime_t;
 
typedef struct tflm_config
{
  unsigned char cpu_num; 
} tflm_config_t;
 
typedef struct tflm_mallinfo
{
  cpuid_t cpu;
  size_t total_bytes;
  size_t used_bytes;
  size_t largest_bytes;
} tflm_mallinfo_t;
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
int tflm_initialize(tflm_config_t *config);
 
int tflm_finalize(void);
 
int tflm_runtime_initialize(tflm_runtime_t *rt,
                            const void *network,
                            int size);
 
int tflm_runtime_finalize(tflm_runtime_t *rt);
 
int tflm_runtime_forward(tflm_runtime_t *rt, const void *inputs[],
                        unsigned char input_num);
 
int tflm_runtime_actual_arenasize(tflm_runtime_t *rt);
 
int tflm_runtime_input_num(tflm_runtime_t *rt);
 
int tflm_runtime_input_size(tflm_runtime_t *rt, unsigned char input_index);
 
int tflm_runtime_input_ndim(tflm_runtime_t *rt, unsigned char input_index);
 
int tflm_runtime_input_shape(tflm_runtime_t *rt, unsigned char input_index,
                            unsigned char dim_index);
 
TfLiteTensor *tflm_runtime_input_variable(tflm_runtime_t *rt,
                                          unsigned char input_index);
 
int tflm_runtime_output_num(tflm_runtime_t *rt);
 
int tflm_runtime_output_size(tflm_runtime_t *rt, unsigned char output_index);
 
int tflm_runtime_output_ndim(tflm_runtime_t *rt, unsigned char output_index);
 
int tflm_runtime_output_shape(tflm_runtime_t *rt, unsigned char output_index,
                              unsigned char dim_index);
 
TfLiteTensor *tflm_runtime_output_variable(tflm_runtime_t *rt,
                                           unsigned char output_index);
 
void *tflm_runtime_output_buffer(tflm_runtime_t *rt,
                                 unsigned char output_index);
 
int tflm_nuttx_mallinfo(tflm_mallinfo_t *info);
 
int tflm_asmp_mallinfo(unsigned char array_length,
                       tflm_mallinfo_t *info_array);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __MODULES_INCLUDE_TFLMRT_RUNTIME_H */