mpcomm.h

Go to the documentation of this file.

/****************************************************************************
 * mpcomm/mpcomm.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_MPCOMM_MPCOMM_H
#define __MODULES_INCLUDE_MPCOMM_MPCOMM_H
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <stdbool.h>
 
#include <asmp/types.h>
#include <asmp/mpmq.h>
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
#define MPCOMM_MSG_ID_INIT 1
 
#define MPCOMM_MSG_ID_DEINIT 2
 
#define MPCOMM_MSG_ID_USER_FUNC 3
 
#define MPCOMM_MSG_ID_DONE 4
 
#define MPCOMM_MSG_ID_MALLOC 5
 
#define MPCOMM_MSG_ID_FREE 6
 
#define MPCOMM_MSG_ID_ERROR 7
 
#define MPCOMM_MSG_ID_LOG 8
 
#define MPCOMM_MAX_HELPERS 4
 
#define MPCOMM_CPUID_MAX 8
 
#define MPCOMM_MODE_CONTROLLER 0
 
#define MPCOMM_MODE_HELPER 1
 
#define MEM_V2P(addr) mpcomm_memory_virt_to_phys(addr)
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
 
typedef void (*mpcomm_user_func_t)(void *data);
 
typedef struct helper_info
{
  mpmq_t mq;
 
  cpuid_t cpuid;
} helper_info_t;
 
typedef struct mpcomm_context
{
  uint8_t mode;
 
  mpmq_t mq_2_supervisor;
 
  mpmq_t mq_2_controller;
 
  helper_info_t helpers[MPCOMM_MAX_HELPERS];
 
  cpu_set_t helpers_cpuset;
 
  cpu_set_t helpers_doneset;
 
  uint8_t supervisor_done;
 
  uint8_t helpers_num;
 
  mpcomm_user_func_t controller_user_func;
 
  mpcomm_user_func_t helper_user_func;
 
  uintptr_t loadaddr;
 
  uint8_t quit_loop;
} mpcomm_context_t;
 
typedef struct mpcomm_init_msg
{
  uint8_t mode;
 
  cpuid_t controller_cpuid;
 
  cpu_set_t helpers_cpuset;
 
  uintptr_t loadaddr;
} mpcomm_init_msg_t;
 
typedef struct mpcomm_malloc_msg
{
  cpuid_t cpuid;
 
  void **ptr;
 
  size_t size;
} mpcomm_malloc_msg_t;
 
typedef struct mpcomm_free_msg
{
  cpuid_t cpuid;
 
  void *ptr;
} mpcomm_free_msg_t;
 
typedef struct mpcomm_error_msg
{
  cpuid_t cpuid;
 
  int error;
} mpcomm_error_msg_t;
 
typedef struct mpcomm_log_msg
{
  cpuid_t cpuid;
 
  char *log;
} mpcomm_log_msg_t;
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
int mpcomm_main(mpcomm_user_func_t controller_user_func,
                mpcomm_user_func_t helper_user_func);
 
int mpcomm_send_helper(uint8_t helper_index, void *data);
 
int mpcomm_wait_helper_done(uint8_t helper_index);
 
int mpcomm_wait_helpers_done(void);
 
int mpcomm_get_helpers_num(void);
 
bool mpcomm_is_controller(void);
 
void *mpcomm_memory_virt_to_phys(void *addr);
 
int mpcomm_send_malloc(void **ptr, size_t size);
 
int mpcomm_send_free(void *ptr);
 
int mpcomm_send_error(int err);
 
int mpcomm_send_log(char *log);
 
#endif /* __MODULES_INCLUDE_MPCOMM_MPCOMM_H */