7.7 VDSP Development Guide

hb_rpmsg_send

Function Declaration

int32_t hb_rpmsg_send(const rpmsg_handle* handle, char *buf, int32_t len);

Parameters

[IN] handle: RPMSG communication handle
[IN] buf: Address of data to send
[IN] len: Length of data to send; valid range: 1 ~ 240

Return Value

Success: number of bytes actually sent
Failure: negative error code; see RPMSG Inter-core Communication API Return Values

Description

Send communication service frame data for a specific service

Example

hb_rpmsg_recv

Function Declaration

int32_t hb_rpmsg_recv(rpmsg_handle* handle, char* buf, int32_t len);

Parameters

[IN] handle: RPMSG communication handle
[OUT] buf: Address of receive buffer
[IN] len: Length of data to receive; valid range: 1 ~ 240

Return Value

Success: number of bytes actually received
Failure: negative error code; see RPMSG Inter-core Communication API Return Values

Description

Receive communication service frame data

hb_rpmsg_send_timeout

Function Declaration

int32_t hb_rpmsg_send_timeout(const rpmsg_handle* handle, char *buf, int32_t len, int32_t timeout);

Parameters

[IN] handle: RPMSG communication handle
[IN] buf: Address of data to send
[IN] len: Length of data to send; valid range: 1 ~ 240
[IN] timeout: Send blocking duration

Return Value

Success: number of bytes actually sent
Failure: negative error code; see RPMSG Inter-core Communication API Return Values

Description

Send communication service frame data with a timeout parameter

Example

#include <stdio.h>
#include <stdlib.h>
#include <pthread.h>
#include <unistd.h>
#include <rpmsg_lib.h>
void usage(char *s)
{
    printf("usage: %s server_name timeout(ms)\n", s);
}
int main(int argc, char *argv[])
{
    int ret = 0;
    struct rpmsg_handle *handle = NULL;
    char buffer[240] = {0};
    int timeout = 0;
    int cnt_max_connect = 10;
    if (argc != 3) {
        usage(argv[0]);
        return -1;
    }
    timeout = atoi(argv[2]);
    if (timeout < 0) {
        printf("invalid timeout: %d\n", timeout);
        usage(argv[0]);
        return -1;
    }
    reconnect:
    ret = hb_rpmsg_connect_server(argv[1], RPMSG_F_BLOCK, timeout,
    &handle);
    if (ret < 0) {
        --cnt_max_connect;
        if ((ret == RPMSG_ERR_NOT_START_SERVER) && (cnt_max_connect)) {
            printf("rpmsg_connect_server error[%d]: %s\n", ret,
                hb_rpmsg_error_message(ret));
            usleep(100 * 1000);
            goto reconnect;
        } else {
            printf("rpmsg_connect_server error[%d]: %s\n", ret,
                hb_rpmsg_error_message(ret));
            return -1;
        }
    }
    while (1) {
        ret = hb_rpmsg_send_timeout(handle, buffer, 240, 1000);
        if (ret < 0) {
            printf("rpmsg_send error[%d]: %s\n", ret,
                hb_rpmsg_error_message(ret));
            hb_rpmsg_disconnect_server(handle);
            return -1;
        } else
            printf("recv log: %s\n", buffer);
            ret = hb_rpmsg_recv_timeout(handle, buffer, 240, 1000);
            if (ret < 0) {
                printf("rpmsg_recv error[%d]: %s\n", ret,
                    hb_rpmsg_error_message(ret));
                hb_rpmsg_disconnect_server(handle);
                return -1;
            }
        }
    }
    return 0;
}

hb_rpmsg_recv_timeout

Function Declaration

int32_t hb_rpmsg_recv_timeout(rpmsg_handle* handle, char* buf, int32_t len, int32_t timeout);

Parameters

[IN] handle: RPMSG communication handle
[OUT] buf: Address of receive buffer
[IN] len: Length of data to receive; valid range: 1 ~ 240
[IN] timeout: Receive blocking duration

Return Value

Success: number of bytes actually received
Failure: negative error code; see RPMSG Inter-core Communication API Return Values

Description

Receive communication service frame data with a timeout parameter

Example

See hb_rpmsg_send_timeout

hb_rpmsg_get_version

Function Declaration

int32_t hb_rpmsg_get_version(uint32_t* major, uint32_t* minor, uint32_t* patch);

Parameters

[OUT] major: Major version number
[OUT] minor: Minor version number
[OUT] patch: Patch version number

Return Value

Success: 0
Failure: negative error code; see RPMSG Inter-core Communication API Return Values

Description

Get the RPMSG shared library version

Example

hb_rpmsg_error_message

Function Declaration

const char* hb_rpmsg_error_message(int32_t error_code);

Parameters

[IN] error_code: Error code

Return Value

Success: error description string
Failure: NULL

Description

Convert an error code to an error description string

Example

Inter-core Communication IPCFHAL APIs

IPCFHAL Inter-core Communication Headers and Libraries

VDSP side

Header file: hb_ipcfhal_interface.h ipcf_hal_errno.h

Library: none
Acore side

Header file: hb_ipcfhal_interface.h ipcf_hal_errno.h

Library: libhbipcfhal.so

IPCFHAL Inter-core Communication API Return Values

#define IPCF_HAL_E_OK           0/**< General OK*/
#define IPCF_HAL_E_NOK          1/**< General Not OK*/
#define IPCF_HAL_E_CONFIG_FAIL      2/**< Config fail*/
#define IPCF_HAL_E_WRONG_CONFIGURATION  3/**< Wrong configuration*/
#define IPCF_HAL_E_NULL_POINTER     4/**< A null pointer was passed as an argument*/
#define IPCF_HAL_E_PARAM_INVALID    5/**< A parameter was invalid*/
#define IPCF_HAL_E_LENGTH_TOO_SMALL 6/**< Length too small*/
#define IPCF_HAL_E_INIT_FAILED      7/**< Initialization failed*/
#define IPCF_HAL_E_UNINIT       8/**< Called before initialization*/
#define IPCF_HAL_E_BUFFER_OVERFLOW  9/**< Source address or destination address Buffer overflow*/
#define IPCF_HAL_E_ALLOC_FAIL       10/**< Source alloc fail*/
#define IPCF_HAL_E_TIMEOUT      11/**< Expired the time out*/
#define IPCF_HAL_E_REINIT       12/**< Re initilize*/
#define IPCF_HAL_E_BUSY         13/**< Busy*/
#define IPCF_HAL_E_CHANNEL_INVALID  14/**< Channel is invalid*/

API return values are the negated values of the macros above.

IPCFHAL Inter-core Communication (VDSP-side) APIs

hb_ipcfhal_init

Function Declaration

int32_t hb_ipcfhal_init(ipcfhal_chan_t *channel);

Parameters

[IN] channel: IPCFHAL channel information

Return Value

Success: 0
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Initialize IPCFHAL

IPCFHAL Initialization Example

info

For full build and run instructions, see /app/vdsp_demo/vdsp_ipcfhal_sample/READTME.md

#define CFG_FILE "config.json"
#define DATA_LEN 1024

static int32_t ipcfhal_thread_func(void *arg, int32_t unused) {
	int32_t ret;
	char *ch_name = "cpu-vdsp-ins0ch0";
	ipcfhal_chan_t channel;
	uint8_t rx_data[DATA_LEN] = {0};
	uint8_t tx_data[DATA_LEN] = {0};
	int32_t timeout = -1;
	uint32_t major, minor, patch;

	ret = vdsp_server_ready(BOOT_COMPLETE_EVENT_MASK_BIT1 | BOOT_COMPLETE_EVENT_MASK_BIT2);

	ret = hb_ipcfhal_get_version(&major, &minor, &patch);
	if (ret < 0) {
		return ret;
	} else {
		printf("ipcfhal verion: %u.%u.%u\n", major, minor, patch);
	}

	ret = hb_ipcfhal_getchan_byjson(ch_name, &channel, CFG_FILE);
	if (ret < 0)
		return ret;
	ret = hb_ipcfhal_init(&channel);
	if (ret < 0)
		return ret;
	ret = hb_ipcfhal_config(&channel);
	if (ret < 0)
		return ret;

	while (hb_is_thread_stop() != 1) {
		memset(tx_data, 0x55, DATA_LEN);
		ret = hb_ipcfhal_send(tx_data, DATA_LEN, &channel);
		if (ret < 0)
			continue;

		memset((void *)rx_data, 0, DATA_LEN);
		ret = hb_ipcfhal_recv(rx_data, DATA_LEN, timeout, &channel);
		if (ret < 0)
			continue;
		for (int i = 0; i < DATA_LEN; i++) {
			if (rx_data[i] != 0x55) {
				DSP_ERR("recv rx_data[%d] err. 0x%x\n", i, rx_data[i]);
				break;
			}
		}
		xos_thread_sleep_msec(2);
	}

	return ret;
}

hb_ipcfhal_getchan_byjson

Function Declaration

int32_t hb_ipcfhal_getchan_byjson(const char *name, ipcfhal_chan_t *channel, const char *json_file);

Parameters

[IN] name: IPCFHAL channel name
[IN] json_file: IPCFHAL JSON configuration file
[OUT] channel: IPCFHAL channel information

Return Value

Success: channel ID
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Get a channel from the IPCFHAL JSON configuration file

Example

hb_ipcfhal_config

Function Declaration

int32_t hb_ipcfhal_config(ipcfhal_chan_t *channel);

Parameters

[IN] channel: IPCFHAL channel information

Return Value

Success: >=0
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Configure an IPCFHAL channel

Example

hb_ipcfhal_send

Function Declaration

int32_t hb_ipcfhal_send(const uint8_t *data, int16_t length, ipcfhal_chan_t *channel);

Parameters

[IN] data: Send data buffer
[IN] length: Send buffer length
[IN] channel: IPCFHAL channel information

Return Value

Success: number of bytes actually sent
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Send an IPCFHAL message

Example

hb_ipcfhal_recv

Function Declaration

int32_t hb_ipcfhal_recv(uint8_t *data, int16_t length, int32_t timeout, ipcfhal_chan_t *channel);

Parameters

[IN] length: Maximum buffer length
[IN] timeout: 0 = non-blocking, >0 = blocking timeout in ms, -1 = blocking
[IN] channel: IPCFHAL channel information
[OUT] data: Receive data buffer

Return Value

Success: number of bytes actually received
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Receive an IPCFHAL message

Example

hb_ipcfhal_deinit

Function Declaration

int32_t hb_ipcfhal_deinit(ipcfhal_chan_t *channel);

Parameters

[IN] channel: IPCFHAL channel information

Return Value

Success: 0
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Deinitialize IPCFHAL

Example

hb_ipcfhal_trans_err

Function Declaration

int32_t hb_ipcfhal_trans_err(int32_t err_code, char **err_str);

Parameters

[IN] err_code: Return value error code
[OUT] err_str: Converted error string

Return Value

Success: 0
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Convert an IPCFHAL error code to an error string

Example

hb_ipcfhal_get_version

Function Declaration

int32_t hb_ipcfhal_get_version(uint32_t *major, uint32_t *minor, uint32_t *patch);

Parameters

[OUT] major: libhbipcfhal major version number
[OUT] minor: libhbipcfhal minor version number
[OUT] patch: libhbipcfhal patch version number

Return Value

Success: 0
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Get the IPCFHAL library version

Example

hb_ipcfhal_register_callback

Function Declaration

int32_t hb_ipcfhal_register_callback(uint8_t *user_data, user_cb_t user_cb, ipcfhal_chan_t *channel);

Parameters

[IN] user_data: User data
[IN] user_cb: User callback function
[IN] channel: IPCFHAL channel information

Return Value

Success: 0
Failure: !=0; see IPCFHAL Inter-core Communication API Return Values

Description

Register an IPCFHAL callback function. On the VDSP side, the receive mode is configured as callback mode. When the parameters are NULL, the callback is unregistered and the VDSP-side receive mode is configured as recv mode. When multiple channels in the same instance use callbacks, execution is blocking; callbacks across channels in different instances run concurrently.

IPCFHAL Register Callback Example

static void test_ipcfhal_callback_func(uint8_t *userdata, int32_t instance, int32_t chan_id,
            uint8_t *buf, uint64_t size)
{
    printf("userdata[0x%llx] ins[%d] ch[%d] buf[0x%llx] size[%llu]\n",
        (uint64_t)userdata, instance, chan_id, (uint64_t)buf, size);
    *userdata = 1u;
}

static int32_t hb_libipchal_register_callback_func(void)
{
    int32_t ret = 0;
    uint8_t user_flag = 0;
    uint32_t cnt = 100u;
    uint8_t rx_data[1024] = {0};
    ipcfhal_chan_t channel;

    printf("hb_libipchal_register_callback_func start\n");
    (void)hb_ipcfhal_getchan_byjson("cpu-vdsp-ch0", &channel, "ipcf_config.json");
    (void)hb_ipcfhal_init(&channel);
    (void)hb_ipcfhal_config(&channel);
    (void)hb_ipcfhal_register_callback(&user_flag, test_ipcfhal_callback_func, &channel);

    while ((user_flag == 0) && (cnt--) ) {
        xos_thread_sleep_msec(100);
    }

    (void)hb_ipcfhal_register_callback(NULL, NULL, &channel);
    (void)hb_ipcfhal_deinit(&channel);
    printf("hb_libipchal_register_callback_func end\n");

    return 0;
}

IPCFHAL Inter-core Communication (Acore-side) APIs

hb_ipcfhal_init

Function Declaration

int32_t hb_ipcfhal_init(ipcfhal_chan_t *channel);

Parameters

[IN] channel: IPCFHAL channel

Return Value

Success: 0
Failure: !=0; see IPCFHAL Inter-core Communication API Return Values

Description

Initialize IPCFHAL

IPCFHAL Initialization Example

info

For full build and run instructions, see /app/vdsp_demo/vdsp_ipcfhal_sample/READTME.md

{
  "log_level": 0,
  "config_num": 2,
  "config_num_max":256,
  "config_0": {
    "name": "cpu2vdsp_ins22ch0",
    "instance": 22,
    "channel": 0,
    "pkg_size_max": 4096,
    "fifo_size": 64000,
    "fifo_type": 0,
    "ipcf_dev_path":"/dev/ipcdrv",
    "ipcf_dev_name":"ipcdrv"
  },
  "config_1": {
    "name": "cpu2vdsp_ins22ch1",
    "instance": 22,
    "channel": 1,
    "pkg_size_max": 4096,
    "fifo_size": 64000,
    "fifo_type": 0,
    "ipcf_dev_path":"/dev/ipcdrv",
    "ipcf_dev_name":"ipcdrv"
  }
}

/*************************************************************************
 *                     COPYRIGHT NOTICE
 *            Copyright 2022-2024, D-Robotics Co., Ltd.
 *                   All rights reserved.
 *************************************************************************/

/******************************************************************************/
/*----------------------------------Includes----------------------------------*/
/******************************************************************************/
#include <sys/time.h>
#include <unistd.h>
#include <stdio.h>
#include <string.h>
#include <getopt.h>
#include <pthread.h>
#include <semaphore.h>
#include <signal.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include <logging.h>
#include <hb_vdsp_mgr.h>
#include "hb_ipcf_hal.h"
#include "ipcf_hal_errno.h"
/******************************************************************************/
/*-----------------------------------Macros-----------------------------------*/
/******************************************************************************/
#define SMP_1KB_LEN		(1024)/**< sample send and recv data length*/
#define SMP_TIMEOUT_VAL		(1000)/**< sample recv timeout value*/
#define SMP_USLEEP_1MS		(1000u)/**< sample sleep 1ms*/
#define SMP_USLEEP_10MS		(10000u)/**< sample sleep 10ms*/
#define SMP_SLEEP_1S		(1u)/**< sample sleep 1s*/
#define SMP_RUN_TIME		(10l)/**< sample run time, unit: s*/
#define SMP_100CNT		(100u)/**< sample 100 counts*/
#define SMP_CHAN_NUM		(1)/**< sample channel number*/
#define SMP_THREAD_NUM		(SMP_CHAN_NUM * 2)/**< sample thread number*/
#define SMP_ROLL_POS		(4)/**< sample rolling count position*/
#define SMP_CFG_FILE	"/app/vdsp_demo/vdsp_ipcfhal_sample/ipcfhal_config.json"

/******************************************************************************/
/*-------------------------Function Prototypes--------------------------------*/
/******************************************************************************/
void *send_pthread(void *argv);
void *recv_pthread(void *argv);

/******************************************************************************/
/*---------------------------- Local Function -------------------------------*/
/******************************************************************************/
/*thread arg*/
struct th_arg_t {
  ipcfhal_chan_t ch;/**< ipcfhal channel*/
  bool Is_Enable;/**< thread status*/
  uint32_t data_len;/**< send data length*/
  uint32_t sleep_time;/**< send period*/
  bool result;/**< thread running result*/
};

volatile sig_atomic_t g_running = true;

void signal_handler(int sig) {
  if (sig == SIGINT)
    g_running = false;
}

static void *tx_pthread(void *argv)
{
  int32_t ret = 0;
  struct th_arg_t *pth_arg = (struct th_arg_t *)argv;
  uint8_t tx_data[SMP_1KB_LEN] = {0u};

  if (pth_arg == NULL) {
    return NULL;
  }

  while (pth_arg->Is_Enable) {
    memset(tx_data, 0x55, SMP_1KB_LEN);
    ret = hb_ipcfhal_send(tx_data, pth_arg->data_len, &pth_arg->ch);
    if (ret != (int32_t)pth_arg->data_len) {/*return data_len*/
      pr_err("Ins[%u]Ch[%u] send failed\n",
        pth_arg->ch.instance, pth_arg->ch.id);
      pth_arg->result = false;
    }
    usleep(pth_arg->sleep_time);
  }

  pr_info("[%s End]Ins[%u]Ch[%u]\n",
    __func__, pth_arg->ch.instance, pth_arg->ch.id);

  return NULL;
}

static void *rx_pthread(void *argv)
{
  int32_t ret = 0;
  struct th_arg_t *pth_arg = (struct th_arg_t *)argv;
  uint8_t data[SMP_1KB_LEN] = {0u};
  int32_t timeout = SMP_TIMEOUT_VAL;

  if (pth_arg == NULL) {
    return NULL;
  }

  while (pth_arg->Is_Enable) {
    memset(data, 0u, pth_arg->data_len);
    ret = hb_ipcfhal_recv(data, SMP_1KB_LEN, timeout, &pth_arg->ch);
    if (ret != -IPCF_HAL_E_TIMEOUT && ret < 0) {
      pr_err("Ins[%u]Ch[%u] recv failed: %d\n",
        pth_arg->ch.instance, pth_arg->ch.id, ret);
      pth_arg->Is_Enable = false;
      pth_arg->result = false;
      break;
    }

    if (ret >= 0) {
      for (int i = 0; i < SMP_1KB_LEN; i++) {
        if (data[i] != 0x55) {
          pr_err("recv data[%d] err. 0x%x\n", i, data[i]);
          break;
        }
      }
    } else if (ret == -IPCF_HAL_E_TIMEOUT) {
      pth_arg->result = false;
    }

    usleep(pth_arg->sleep_time);
  }
  pr_info("[%s End]Ins[%u]Ch[%u]\n",
    __func__, pth_arg->ch.instance, pth_arg->ch.id);

  return NULL;
}

/******************************************************************************/
/*---------------------------- Global Function -------------------------------*/
/******************************************************************************/
int main(int argc, char *argv[])
{
  const char *json_path = SMP_CFG_FILE;
  struct timespec test_start_time, test_cur_time;
  int32_t ret = 0;
  bool result = true;
  pthread_t thread_tid[SMP_THREAD_NUM];
  struct th_arg_t thread_arg[SMP_CHAN_NUM];
  const char *chan_name[SMP_CHAN_NUM] = {
    "cpu2vdsp_ins22ch0"
  };
  int32_t vdsp_id = 0;
  int32_t timeout = 1000;
  const char *vdsp_pathname = "/app/vdsp_demo/vdsp_ipcfhal_sample/res/q8sample";

  signal(SIGINT, signal_handler);

  ret = hb_vdsp_init(vdsp_id);
  if (ret) {
    pr_err("vdsp init failed, ret %d\n", ret);
    return ret;
  }

  ret = hb_vdsp_start(vdsp_id, timeout, vdsp_pathname);
  if (ret) {
    pr_err("vdsp start failed, ret %d\n", ret);
    return ret;
  }

  for (int32_t i = 0; i < SMP_CHAN_NUM; i++) {
    /*step1: get channel info by json file*/
    ret = hb_ipcfhal_getchan_byjson(chan_name[i], &thread_arg[i].ch, json_path);
    if (ret < 0) {/* return channel id*/
      pr_err("%s not found, ret %d\n", chan_name[i], ret);
      hb_vdsp_stop(vdsp_id);
      hb_vdsp_deinit(vdsp_id);
      return ret;
    }

    /*step2: init channel*/
    ret = hb_ipcfhal_init(&thread_arg[i].ch);
    if (ret < 0) {
      pr_err("%s init failed, ret %d\n", thread_arg[i].ch.name, ret);
      for (int32_t j = 0; j < i; j++) {
        hb_ipcfhal_deinit(&thread_arg[j].ch);
      }
      hb_vdsp_stop(vdsp_id);
                        hb_vdsp_deinit(vdsp_id);
      return ret;
    }

    /*step3: config channel*/
    ret = hb_ipcfhal_config(&thread_arg[i].ch);
    if (ret < 0) {
      pr_err("%s config failed, ret %d\n", thread_arg[i].ch.name, ret);
      for (int32_t j = 0; j <= i; j++) {
        hb_ipcfhal_deinit(&thread_arg[j].ch);
      }
      hb_vdsp_stop(vdsp_id);
                        hb_vdsp_deinit(vdsp_id);
      return ret;
    }

    /*step4: set thread arg*/
    thread_arg[i].sleep_time = SMP_USLEEP_10MS;
    thread_arg[i].data_len = SMP_1KB_LEN;
    thread_arg[i].Is_Enable = true;
    thread_arg[i].result = true;
    (void)pthread_create(&thread_tid[i], NULL, rx_pthread, &thread_arg[i]);
    (void)pthread_create(&thread_tid[i+1], NULL, tx_pthread, &thread_arg[i]);
  }

  /*step5: run send and recv thread*/
  clock_gettime(CLOCK_MONOTONIC, &test_start_time);
  clock_gettime(CLOCK_MONOTONIC, &test_cur_time);
  while (g_running) {
    for (int32_t i = 0; i < SMP_CHAN_NUM; i++) {
      if (thread_arg[i].Is_Enable == false)
        break;
    }
    if (test_cur_time.tv_sec - test_start_time.tv_sec > SMP_RUN_TIME)
      break;

    sleep(SMP_SLEEP_1S);
    clock_gettime(CLOCK_MONOTONIC, &test_cur_time);
  }

  /*step6: deinit channel*/
  for (int32_t i = 0; i < SMP_CHAN_NUM; i++) {
    void *ret;
    thread_arg[i].Is_Enable = false;//stop thread
    usleep(SMP_USLEEP_10MS);
    pthread_join(thread_tid[i], &ret);
    pthread_join(thread_tid[i+1], &ret);
    (void)hb_ipcfhal_deinit(&thread_arg[i].ch);

    result = (result && thread_arg[i].result);
  }

  if (result == false) {
    pr_err("[ipc-sample] ipc sample running failed\n");
  } else {
    pr_info("[ipc-sample] ipc sample running success\n");
  }

  ret = hb_vdsp_stop(vdsp_id);
  if (ret) {
    pr_err("vdsp stop failed, ret %d\n", ret);
    return ret;
  }

  ret = hb_vdsp_deinit(vdsp_id);
  if (ret) {
    pr_err("vdsp deinit failed, ret %d\n", ret);
    return ret;
  }
  return ret;
}

hb_ipcfhal_getchan_byjson

Function Declaration

int32_t hb_ipcfhal_getchan_byjson(const char *name, ipcfhal_chan_t *channel, const char *json_file);

Parameters

[IN] name: IPCFHAL channel name
[IN] json_file: IPCFHAL JSON configuration file
[OUT] channel: IPCFHAL channel information

Return Value

Success: >=0
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Get a channel from the IPCFHAL JSON configuration file. After channel initialization, modifying structure member values is not supported.

Example

hb_ipcfhal_config

Function Declaration

int32_t hb_ipcfhal_config(ipcfhal_chan_t *channel);

Parameters

[IN] channel: IPCFHAL channel information

Return Value

Success: >=0
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Configure an IPCFHAL channel

Example

hb_ipcfhal_send

Function Declaration

int32_t hb_ipcfhal_send(const uint8_t *data, uint32_t length, ipcfhal_chan_t *channel);

Parameters

[IN] data: Send data buffer
[IN] length: Send buffer length
[IN] channel: Channel information

Return Value

Success: number of bytes actually sent
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Send an IPCFHAL message

Example

hb_ipcfhal_recv

Function Declaration

int32_t hb_ipcfhal_recv(uint8_t *data, uint32_t length, int32_t timeout, ipcfhal_chan_t *channel);

Parameters

[IN] length: Maximum buffer length
[IN] timeout: 0 = non-blocking, >0 = blocking timeout in ms, -1 = blocking
[IN] channel: Channel information
[OUT] data: Receive data buffer

Return Value

Success: number of bytes actually received
Failure: <0; see IPCFHAL Inter-core Communication API Return Values

Description

Receive an IPCFHAL message

Example

hb_ipcfhal_deinit

Function Declaration

int32_t hb_ipcfhal_deinit(ipcfhal_chan_t *channel);

Parameters

[IN] channel: Channel information

Return Value

Success: 0
Failure: !=0; see IPCFHAL Inter-core Communication API Return Values

Description

Deinitialize IPCFHAL

Example

hb_ipcfhal_trans_err

Function Declaration

int32_t hb_ipcfhal_trans_err(int32_t err_code, char **err_str);

Parameters

[IN] err_code: Return value error code
[OUT] err_str: Converted error string

Return Value

Success: 0
Failure: !=0; see IPCFHAL Inter-core Communication API Return Values

Description

Convert an IPCFHAL error code to an error string

Example

hb_ipcfhal_get_version

Function Declaration

int32_t hb_ipcfhal_get_version(uint32_t *major, uint32_t *minor, uint32_t *patch);

Parameters

[OUT] major: libhbipcfhal major version number
[OUT] minor: libhbipcfhal minor version number
[OUT] patch: libhbipcfhal patch version number

Return Value

Success: 0
Failure: !=0; see IPCFHAL Inter-core Communication API Return Values

Description

Get the IPCFHAL library version

Example

HEAP Allocation APIs

HEAP Allocation Headers and Libraries

VDSP side

Header file: hb_mem_allocator.h

Library: none

HEAP Allocation API Return Values

#define HB_MEM_OK                                    0
#define HB_MEM_ERR_INVALID_PARAMS                    (-16777215)
#define HB_MEM_ERR_REPEAT_INIT                       (-16777214)
#define HB_MEM_ERR_HEAP_BUSY                         (-16777213)
#define HB_MEM_ERR_INSUFFICIENT_MEM                  (-16777212)

HEAP Allocation APIs

hb_mem_heap_initialize

Function Declaration

int32_t hb_mem_heap_initialize(hb_mem_heap_t heap_id, void *start_vaddr, size_t heap_size, uint32_t align);

Parameters

[IN] heap_id: Valid heap index; valid values: 0, 1
[IN] start_vaddr: Heap start address
[IN] heap_size: Heap size
[IN] align: Heap alignment size

Return Value

Success: 0
Failure: <0; see HEAP Allocation API Return Values

Description

Initialize the heap allocation APIs

Example

int32_t ret;
void *start_vaddr[2] = {(void *)heapDRAM0, heapDRAM1};
size_t heap_size[2] = {sizeof(heapDRAM0), sizeof(heapDRAM1)};
ret = hb_mem_heap_initialize(HB_MEMRY_HEAP_DRAM_0, start_vaddr[0],
    heap_size[0], 0x10000);
if (ret < 0) {
    printf("hb_mem_heap_initialize failed ret = %d\n", ret);
    return ret;
}
ret = hb_mem_heap_deinitialize(HB_MEMRY_HEAP_DRAM_0);
if (ret < 0) {
    printf("hb_mem_heap_deinitialize failed ret = %d\n", ret);
    return ret;
}
return 0;

hb_mem_heap_deinitialize

Function Declaration

int32_t hb_mem_heap_deinitialize(hb_mem_heap_t heap_id);

Parameters

[IN] heap_id: Valid heap index; valid values: 0, 1

Return Value

Success: 0
Failure: <0; see HEAP Allocation API Return Values

Description

Deinitialize the heap allocation APIs

Example

int32_t ret;
void *start_vaddr[2] = {(void *)heapDRAM0, heapDRAM1};
size_t heap_size[2] = {sizeof(heapDRAM0), sizeof(heapDRAM1)};
ret = hb_mem_heap_initialize(HB_MEMRY_HEAP_DRAM_0, start_vaddr[0],
    heap_size[0], 0x10000);
if (ret < 0) {
    printf("hb_mem_heap_initialize failed ret = %d\n", ret);
    return ret;
}
ret = hb_mem_heap_deinitialize(HB_MEMRY_HEAP_DRAM_0);
if (ret < 0) {
    printf("hb_mem_heap_deinitialize failed ret = %d\n", ret);
    return ret;
}
return 0;

hb_mem_heap_alloc

Function Declaration

int32_t hb_mem_heap_alloc(hb_mem_heap_t heap_id, size_t req_size, uint32_t align, void ** vaddr);

Parameters

[IN] heap_id: Valid heap index; valid values: 0, 1
[IN] req_size: Number of bytes to allocate
[IN] align: Heap alignment size
[OUT] vaddr: Start address of allocated buffer

Return Value

Success: 0
Failure: <0; see HEAP Allocation API Return Values

Description

Heap allocation API

Example

int32_t ret;
void *start_vaddr[2] = {(void *)heapDRAM0, heapDRAM1};
size_t heap_size[2] = {sizeof(heapDRAM0), sizeof(heapDRAM1)};
uint32_t malloc_alignment = 64;
void *vaddr = NULL;
ret = hb_mem_heap_initialize(HB_MEMRY_HEAP_DRAM_0, start_vaddr[0],
heap_size[0], 0x10000);
if (ret < 0) {
    printf("hb_mem_heap_initialize failed ret = %d\n", ret);
    return ret;
}
ret = hb_mem_heap_alloc(HB_MEMRY_HEAP_DRAM_0, heap_size[0],
    malloc_alignment, &vaddr);
if (ret < 0) {
    printf("hb_mem_heap_alloc failed ret = %d\n", ret);
    hb_mem_heap_deinitialize(HB_MEMRY_HEAP_DRAM_0);
    return ret;
}
ret = hb_mem_heap_free(HB_MEMRY_HEAP_DRAM_0, vaddr);
if (ret < 0) {
    printf("hb_mem_heap_free failed ret = %d\n", ret);
    hb_mem_heap_deinitialize(HB_MEMRY_HEAP_DRAM_0);
    return ret;
}
ret = hb_mem_heap_deinitialize(HB_MEMRY_HEAP_DRAM_0);
return 0;

hb_mem_heap_free

Function Declaration

int32_t hb_mem_heap_free(hb_mem_heap_t heap_id, void *vaddr);

Parameters

[IN] heap_id: Valid heap index; valid values: 0, 1
[IN] vaddr: Start address of allocated buffer

Return Value

Success: 0
Failure: <0; see HEAP Allocation API Return Values

Description

Free allocated heap space

Example

int32_t ret;
void *start_vaddr[2] = {(void *)heapDRAM0, heapDRAM1};
size_t heap_size[2] = {sizeof(heapDRAM0), sizeof(heapDRAM1)};
uint32_t malloc_alignment = 64;
void *vaddr = NULL;
ret = hb_mem_heap_initialize(HB_MEMRY_HEAP_DRAM_0, start_vaddr[0],
heap_size[0], 0x10000);
if (ret < 0) {
    printf("hb_mem_heap_initialize failed ret = %d\n", ret);
    return ret;
}
ret = hb_mem_heap_alloc(HB_MEMRY_HEAP_DRAM_0, heap_size[0],
    malloc_alignment, &vaddr);
if (ret < 0) {
    printf("hb_mem_heap_alloc failed ret = %d\n", ret);
    hb_mem_heap_deinitialize(HB_MEMRY_HEAP_DRAM_0);
    return ret;
}
ret = hb_mem_heap_free(HB_MEMRY_HEAP_DRAM_0, vaddr);
if (ret < 0) {
    printf("hb_mem_heap_free failed ret = %d\n", ret);
    hb_mem_heap_deinitialize(HB_MEMRY_HEAP_DRAM_0);
    return ret;
}
ret = hb_mem_heap_deinitialize(HB_MEMRY_HEAP_DRAM_0);
if (ret < 0) {
    printf("hb_mem_heap_deinitialize failed ret = %d\n", ret);
    return ret;
}
return 0;

hb_mem_heap_get_status

Function Declaration

int32_t hb_mem_heap_get_status(hb_mem_heap_t heap_id, hb_mem_heap_status_t *heap_status);

Parameters

[IN] heap_id: Valid heap index; valid values: 0, 1
[OUT] heap_status: Heap status information

Return Value

Success: 0
Failure: <0; see HEAP Allocation API Return Values

Description

Get heap allocation status

Example

int32_t ret;
void *start_vaddr[2] = {(void *)heapDRAM0, heapDRAM1};
size_t heap_size[2] = {sizeof(heapDRAM0), sizeof(heapDRAM1)};
hb_mem_heap_status_t heap_status = {0, };
ret = hb_mem_heap_initialize(HB_MEMRY_HEAP_DRAM_0, start_vaddr[0],
    heap_size[0], 0x10000);
if (ret < 0) {
    printf("hb_mem_heap_initialize failed ret = %d\n", ret);
    return ret;
}
ret = hb_mem_heap_get_status(HB_MEMRY_HEAP_DRAM_0, &heap_status);
if (ret < 0) {
    printf("hb_mem_heap_get_status failed ret = %d\n", ret);
    hb_mem_heap_deinitialize(HB_MEMRY_HEAP_DRAM_0);
    return ret;
}
ret = hb_mem_heap_deinitialize(HB_MEMRY_HEAP_DRAM_0);
if (ret < 0) {
    printf("hb_mem_heap_deinitialize failed ret = %d\n", ret);
    return ret;
}
return 0;

VDSP Boot/Stop Control APIs

VDSP Boot/Stop Control Headers and Libraries

Acore side

Header file: hb_vdsp_mgr.h

Library: libvdsp.so

VDSP Boot/Stop Control API Return Values

#define HB_VDSP_OK                      (0)
#define HB_VDSP_OPEN_DEV_ERR                    (-1)
#define HB_VDSP_START_IOCTL_ERR                 (-2)
#define HB_VDSP_STOP_IOCTL_ERR                  (-4)
#define HB_VDSP_GET_STATUS_IOCTL_ERR                (-5)
#define HB_VDSP_RESET_IOCTL_ERR                 (-6)
#define HB_VDSP_PARAM_INVALID                   (-7)
#define HB_VDSP_SET_PATH_ERR                    (-8)
#define HB_VDSP_SET_NAME_ERR                    (-9)
#define HB_VDSP_CLOSE_DEV_ERR                   (-10)
#define HB_VDSP_ERR_IOC_GET_VERSION_INFO            (-11)
#define HB_VDSP_ERR_IOC_MEM_ALLOC               (-12)
#define HB_VDSP_ERR_IOC_MEM_FREE                (-13)
#define HB_VDSP_ERR_IOC_SMMU_MAP                (-14)
#define HB_VDSP_ERR_IOC_SMMU_UNMAP              (-15)
#define HB_VDSP_ERR_INIT                    (-16)
#define HB_VDSP_ERR_DEINIT                  (-17)
#define HB_VDSP_ERR_NOT_INITED                  (-18)
#define HB_VDSP_ERR_ALLOC_COM_BUF               (-19)
#define HB_VDSP_ERR_FREE_MEMBUF                 (-20)
#define HB_VDSP_ERR_GET_COM_BUF_WITH_VADDR          (-21)
#define HB_VDSP_ERR_SMMU_MAP                    (-22)
#define HB_VDSP_ERR_SMMU_UNMAP                  (-23)
#define HB_VDSP_ERR_CHECK_VERSION               (-24)
#define HB_VDSP_ERR_INSUFFICIENT_MEM                (-25)
#define HB_VDSP_ERR_MISMATCH_INTERFACE              (-26)
#define HB_VDSP_ERR_RBTREE_CREATE_NODE              (-27)
#define HB_VDSP_ERR_RBTREE_INSERT_NODE              (-28)
#define HB_VDSP_ERR_RBTREE_SEARCH_NODE              (-29)

VDSP Boot/Stop Control APIs

hb_vdsp_get_version

Function Declaration

int32_t hb_vdsp_get_version(uint32_t *major, uint32_t *minor, uint32_t *patch);

Parameters

[OUT] major: libvdsp major version number
[OUT] minor: libvdsp minor version number
[OUT] patch: libvdsp patch version number

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Get the VDSP boot/stop control library version

Get VDSP Library Version Example

#include <hb_vdsp_mgr.h>

int32_t boot_lib_version_test(int32_t dsp_id)
{
    int32_t ret = 0;
    uint32_t major, minor, patch;

    ret = hb_vdsp_get_version(&major, &minor, &patch);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_get_version ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    printf("%s Get version %d.%d.%d.\n", TAG, major, minor, patch);

    return ret;
}

hb_vdsp_init

Function Declaration

int32_t hb_vdsp_init(int32_t dsp_id);

Parameters

[IN] dsp_id: DSP index; valid values: 0, 1, corresponding to dsp0 and dsp1

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Initialize the VDSP boot/stop control library

Initialize VDSP Library Example

#include <hb_vdsp_mgr.h>

int32_t boot_lib_init_test(int32_t dsp_id)
{
    int32_t ret = 0;

    ret = hb_vdsp_init(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_init ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    ret = hb_vdsp_deinit(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_deinit ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    return ret;
}

hb_vdsp_deinit

Function Declaration

int32_t hb_vdsp_deinit(int32_t dsp_id);

Parameters

[IN] dsp_id: DSP index; valid values: 0, 1, corresponding to dsp0 and dsp1

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Release the VDSP boot/stop control library

Example

See hb_vdsp_init

hb_vdsp_start

Function Declaration

int32_t hb_vdsp_start(int32_t dsp_id, int32_t timeout, const char *pathname);

Parameters

[IN] dsp_id: DSP index; valid values: 0, 1, corresponding to dsp0 and dsp1
[IN] timeout: 0 = asynchronous; -1 = synchronous; >0 = synchronous timeout wait time in ms
[IN] pathname: Full VDSP image path, including the image name

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Start VDSP

Synchronously Start VDSP Example

#include <hb_vdsp_mgr.h>

#define VDSP_BOOT_MODE_ASYNC        (0)
#define VDSP_BOOT_MODE_SYNC         (-1)

int32_t boot_lib_sync_test(int32_t dsp_id, const char* pathname)
{
    int32_t ret = 0;
    int32_t status = 0;

    ret = hb_vdsp_init(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_init ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    ret = hb_vdsp_start(dsp_id, VDSP_BOOT_MODE_SYNC, pathname);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_start ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_get_status(dsp_id, &status);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_get_status ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_stop(dsp_id);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_stop(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_stop ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_deinit(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_deinit ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    printf("%s dsp%d boot sync pass !\n", __func__, dsp_id);
    return ret;
}

boot_lib_sync_test(0, "/app/vdsp_demo/vdsp_sample/res/q8sample");
boot_lib_sync_test(1, "/app/vdsp_demo/vdsp_sample/res/q8sample");

Asynchronously Start VDSP Example

#include <hb_vdsp_mgr.h>
#include <poll.h>

#define VDSP_BOOT_MODE_ASYNC        (0)
#define VDSP_BOOT_MODE_SYNC         (-1)

int32_t boot_lib_async_test(int32_t dsp_id, const char* pathname)
{
    int32_t ret = 0;
    struct pollfd pollfds;
    int32_t fd;

    ret = hb_vdsp_init(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_init ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    ret = hb_vdsp_start(dsp_id, VDSP_BOOT_MODE_ASYNC, pathname);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_start ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_get_fd(dsp_id, &fd);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_get_fd ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_stop(dsp_id);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    pollfds.fd = fd;
    pollfds.events = POLLIN | POLLRDNORM;

    printf("%s dsp%d poll entry pollfds.events=0x%x fd-%d.\n", __func__, dsp_id, pollfds.events, fd);

    ret = poll(&pollfds, 1, 600);
    printf("%s dsp%d poll return pollfds.revents=0x%x ret-%d.\n", __func__, dsp_id, pollfds.revents, ret);
    if (ret <= 0) {
        printf("%s dev poll err: %d, %s\n", __func__, errno, strerror(errno));
        hb_vdsp_close_fd(fd);
        hb_vdsp_stop(dsp_id);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_close_fd(fd);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_close_fd ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_stop(dsp_id);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_stop(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_stop ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_deinit(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_deinit ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    printf("%s dsp%d boot async pass !\n", __func__, dsp_id);
    return ret;
}

boot_lib_async_test(0, "/app/vdsp_demo/vdsp_sample/res/q8sample");
boot_lib_async_test(1, "/app/vdsp_demo/vdsp_sample/res/q8sample");

hb_vdsp_stop

Function Declaration

int32_t hb_vdsp_stop(int32_t dsp_id);

Parameters

[IN] dsp_id: DSP index; valid values: 0, 1, corresponding to dsp0 and dsp1

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Stop VDSP

Example

hb_vdsp_get_status

Function Declaration

int32_t hb_vdsp_get_status(int32_t dsp_id, int32_t *status);

Parameters

[IN] dsp_id: DSP index; valid values: 0, 1, corresponding to dsp0 and dsp1
[OUT] status: VDSP running status

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Get VDSP running status

::: tip This API does not support concurrent use from multiple processes or threads. :::

Example

hb_vdsp_reset

Function Declaration

int32_t hb_vdsp_reset(int32_t dsp_id);

Parameters

[IN] dsp_id: DSP index; valid values: 0, 1, corresponding to dsp0 and dsp1

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Reset VDSP

Example

#include <hb_vdsp_mgr.h>

#define VDSP_BOOT_MODE_ASYNC        (0)
#define VDSP_BOOT_MODE_SYNC         (-1)

int32_t boot_lib_reset_test(int32_t dsp_id, const char* pathname)
{
    int32_t ret = 0;
    int32_t status = RPROC_OFFLINE;

    ret = hb_vdsp_init(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_init ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    ret = hb_vdsp_start(dsp_id, VDSP_BOOT_MODE_SYNC, pathname);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_start ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_get_status(dsp_id, &status);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_get_status ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_stop(dsp_id);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_reset(dsp_id);
    if (ret != HB_VDSP_OK) {
        ALOGE("%s dsp%d hb_vdsp_reset ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_stop(dsp_id);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_stop(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_stop ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_deinit(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_deinit ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    printf("%s dsp%d reset pass !\n", __func__, dsp_id);
    return ret;
}

boot_lib_reset_test(0, "/app/vdsp_demo/vdsp_sample/res/q8sample");
boot_lib_reset_test(1, "/app/vdsp_demo/vdsp_sample/res/q8sample");

hb_vdsp_set_path

Function Declaration

int32_t hb_vdsp_set_path(int32_t dsp_id, const char* path);

Parameters

[IN] dsp_id: DSP index; valid values: 0, 1, corresponding to dsp0 and dsp1
[IN] path: Full VDSP image path, excluding the image name

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Set the VDSP image path

Example

#include <hb_vdsp_mgr.h>

#define VDSP_BOOT_MODE_ASYNC        (0)
#define VDSP_BOOT_MODE_SYNC         (-1)

int32_t boot_lib_set_pathname_test(int32_t dsp_id, const char* path, const char* name)
{
    int32_t ret = 0;
    int32_t status = 0;

    ret = hb_vdsp_init(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_init ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    ret = hb_vdsp_set_path(dsp_id, path);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_set_path ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_set_name(dsp_id, name);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_set_name ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_start(dsp_id, VDSP_BOOT_MODE_SYNC, NULL);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_start ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_get_status(dsp_id, &status);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_get_status ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_stop(dsp_id);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_stop(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_stop ret-%d fail !\n", __func__, dsp_id, ret);
        hb_vdsp_deinit(dsp_id);
        return ret;
    }

    ret = hb_vdsp_deinit(dsp_id);
    if (ret != HB_VDSP_OK) {
        printf("%s dsp%d hb_vdsp_deinit ret-%d fail !\n", __func__, dsp_id, ret);
        return ret;
    }

    printf("%s dsp%d set path & name pass !\n", __func__, dsp_id);
    return ret;
}

boot_lib_set_pathname_test(0, "/app/testcase/S05_VDSP/testsuite", "q8sample");
boot_lib_set_pathname_test(1, "/app/testcase/S05_VDSP/testsuite", "q8sample");

hb_vdsp_set_name

Function Declaration

int32_t hb_vdsp_set_name(int32_t dsp_id, const char* name);

Parameters

[IN] dsp_id: DSP index; valid values: 0, 1, corresponding to dsp0 and dsp1
[IN] name: VDSP image name

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Set the VDSP image name

Example

See hb_vdsp_set_path

hb_vdsp_get_fd

Function Declaration

int32_t hb_vdsp_get_fd(int32_t dsp_id, int32_t *retfd);

Parameters

[IN] dsp_id: DSP index; valid values: 0, 1, corresponding to dsp0 and dsp1
[OUT] retfd: VDSP device file descriptor

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Open and return the VDSP device file descriptor

Example

hb_vdsp_close_fd

Function Declaration

int32_t hb_vdsp_close_fd(int32_t fd);

Parameters

[IN] fd: VDSP device file descriptor

Return Value

Success: 0
Failure: negative error code; see VDSP Boot/Stop Control API Return Values

Description

Close the VDSP device

Example