nvmedia_dla.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019, NVIDIA CORPORATION. All rights reserved. All
 * information contained herein is proprietary and confidential to NVIDIA
 * Corporation.  Any use, reproduction, or disclosure without the written
 * permission of NVIDIA Corporation is prohibited.
 */


#ifndef NVMEDIA_DLA_H
#define NVMEDIA_DLA_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_core.h"
#include "nvmedia_tensor.h"

#define NVMEDIA_DLA_VERSION_MAJOR   3

#define NVMEDIA_DLA_VERSION_MINOR   2

#define NVMEDIA_DLA_TENSOR_DESC_NAME_MAX_LEN (80)

#define NVMEDIA_DLA_DEFAULT_TASKTIMEOUT 100000

typedef struct NvMediaDla NvMediaDla;

typedef struct {
    uint8_t major;
    uint8_t minor;
    uint8_t subMinor;
} NvMediaDlaUMDVersion;

typedef enum {
    NVMEDIA_DLA_DATA_TYPE_TENSOR
} NvMediaDlaDataType;

typedef struct {
    NvMediaTensor *tensor;
} NvMediaDlaDataPointer;

typedef struct {
    NvMediaDlaDataType type;
    NvMediaDlaDataPointer pointer;
} NvMediaDlaData;

typedef struct NvMediaDlaLoadable NvMediaDlaLoadable;

typedef struct {
    uint8_t *loadable;
    uint64_t loadableSize;
} NvMediaDlaBinaryLoadable;

typedef struct {
    NvMediaDlaData *dlaData;
    uint32_t numArgs;
} NvMediaDlaArgs;

typedef struct {
    char name[NVMEDIA_DLA_TENSOR_DESC_NAME_MAX_LEN + 1];
    NvMediaTensorAttr tensorAttrs[NVM_TENSOR_ATTR_MAX];
    uint32_t numAttrs;
} NvMediaDlaTensorDescriptor;

NvMediaStatus
NvMediaDlaGetVersion(
    NvMediaVersion *version
);

NvMediaStatus
NvMediaDlaPingById(
    const uint32_t dlaId
);

NvMediaDla *
NvMediaDlaCreate(void);

NvMediaStatus
NvMediaDlaDestroy(
     NvMediaDla *dla
);

NvMediaStatus
NvMediaDlaGetUMDVersion(
    const NvMediaDla *dla,
    NvMediaDlaUMDVersion *version
);

NvMediaStatus
NvMediaDlaGetNumEngines(
    const NvMediaDla *dla,
    uint16_t *numEngines
);

NvMediaStatus
NvMediaDlaGetMaxOutstandingTasks(
    const NvMediaDla *dla,
    uint32_t *maxOutstandingTasks
);

NvMediaStatus
NvMediaDlaInit(
    NvMediaDla *dla,
    uint32_t dlaId,
    uint32_t numTasks
);

NvMediaStatus
NvMediaDlaGetInstanceId(
    const NvMediaDla *dla,
    uint32_t *dlaId
);

NvMediaStatus
NvMediaDlaGetNumTasks(
    const NvMediaDla *dla,
    uint32_t *numTasks
);

NvMediaStatus
NvMediaDlaLoadableCreate(
    NvMediaDla *dla,
    NvMediaDlaLoadable **loadable
);

NvMediaStatus
NvMediaDlaLoadableDestroy(
    const NvMediaDla *dla,
    NvMediaDlaLoadable *loadable
);

NvMediaStatus
NvMediaDlaAppendLoadable(
    const NvMediaDla *dla,
    const NvMediaDlaBinaryLoadable binaryLoadable,
    NvMediaDlaLoadable *loadable
);

NvMediaStatus
NvMediaDlaSetCurrentLoadable(
    const NvMediaDla *dla,
    const NvMediaDlaLoadable *loadable
);

NvMediaStatus
NvMediaDlaGetNumOfInputTensors(
    const NvMediaDla *dla,
    int32_t *numOfInputTensors
);

NvMediaStatus
NvMediaDlaGetInputTensorDescriptor(
    const NvMediaDla *dla,
    const uint32_t idx,
    NvMediaDlaTensorDescriptor *descriptor
);

NvMediaStatus
NvMediaDlaGetNumOfOutputTensors(
    const NvMediaDla *dla,
    int32_t *numOfOutputTensors
);

NvMediaStatus
NvMediaDlaGetOutputTensorDescriptor(
    const NvMediaDla *dla,
    const uint32_t idx,
    NvMediaDlaTensorDescriptor *descriptor
);

NvMediaStatus
NvMediaDlaDataRegister(
    const NvMediaDla *dla,
    const NvMediaDlaData *dlaData,
    uint32_t flags
);

NvMediaStatus
NvMediaDlaDataUnregister(
    const NvMediaDla *dla,
    const NvMediaDlaData *dlaData
);

NvMediaStatus
NvMediaDlaLoadLoadable(
    NvMediaDla *dla
);

NvMediaStatus
NvMediaDlaRemoveLoadable(
    const NvMediaDla *dla
);

NvMediaStatus
NvMediaDlaSubmit(
    NvMediaDla *dla,
    const NvMediaDlaArgs *inputArgs,
    const NvMediaDlaArgs *scratchpadArgs,
    NvMediaDlaArgs *outputArgs,
    uint32_t taskTimeout
);

NvMediaStatus
NvMediaDlaLoadFromMemory(
    NvMediaDla *dla,
    uint8_t *loadable,
    uint64_t loadableSize,
    uint16_t dlaId,
    uint32_t numOutstandingRequests
);

NvMediaStatus
NvMediaDlaSubmitTimeout(
    NvMediaDla *dla,
    const NvMediaDlaArgs *inputArgs,
    NvMediaDlaArgs *outputArgs,
    uint32_t taskTimeout
);

NvMediaStatus
NvMediaDlaGetMaxOutstandingRequests(
    const NvMediaDla *dla,
    uint32_t *maxOutstandingRequests
);

/*
 * \defgroup history_nvmedia_dla History
 * Provides change history for the NvMedia DLA API.
 *
 * \section history_nvmedia_dla Version History
 *
 * <b> Version 1.0 </b> Oct 31, 2017
 * - Initial Release.
 *
 * <b> Version 1.1 </b> Feb 12, 2018
 * - Add separate functionality to load from memory.
 *
 * <b> Version 1.2 </b> Mar 12, 2018
 * - Add query API's for version, num engines, maxOutstandingRequests.
 *
 * <c> Version 1.3 </b> Mar 26, 2018
 * - Add helper to query tensor descriptor.
 *
 * <c> Version 1.4 </b> May 3, 2018
 * - Add dynamic task timeout support.
 *
 * <c> Version 2.0 </b> June 26, 2018
 * - Remove load using filename functionality.
 *
 * <c> Version 2.1 </b> August 13, 2018
 * - Add NvMediaDlaPingById. NvMediaDlaPing will be deprecated in the future.
 *
 * <c> Version 2.2 </b> Oct 1, 2018
 * - Add new API NvMediaDlaGetUMDVersion and data structure NvMediaDlaUMDVersion.
 *
 * <c> Version 2.3 </b> Dec 14, 2018
 * - Add new API NvMediaLoadableIdCreate, NvMediaLoadableIdDestroy,
 *   NvMediaDlaAppendLoadable, NvMediaDlaLoadLoadable, NvMediaDlaSetCurrentLoadable,
 *   NvMediaDlaInit, NvMediaDlaGetScratchpadDescriptor and NvMediaDlaBindScratchpad.
 * - Add new structure NvMediaDlaLoadableId, NvMediaDlaLoadable and NvMediaDlaScratchpadDescriptor.
 *
 * <c> Version 2.4 </b> Jan 9, 2019
 * - Remove NvMediaImage as Dla data.
 *
 * <c> Version 2.5 </b> Mar 7, 2019
 * - Rename NvMediaLoadableIdCreate to NvMediaDlaLoadableIdCreate.
 * - Rename NvMediaLoadableIdDestroy to NvMediaDlaLoadableIdDestroy.
 *
 * <c> Version 2.6 </b> Mar 11, 2019
 * - Add new API NvMediaDlaDataRegister and NvMediaDlaDataUnRegister.
 *
 * <c> Version 2.7 </b> Mar 13, 2019
 * - Deprecate NvMediaDlaPing API.
 *
 * <c> Version 2.8 </b> Mar 14, 2019
 * - Deprecate NvMediaDlaSubmit API.
 *
 * <c> Version 3.0 </b> April 19, 2019
 * - Move to new APIs.
 *
 * <c> Version 3.1 </b> July 08, 2019
 * - Remove the restriction of calling sequence for data registration.
 *
 * <c> Version 3.2 </b> July 30, 2019
 * - Deleting NvMediaDlaGetScratchpadDescriptor and NvMediaDlaBindScratchpad.
 * - added const for parameters in APIs that do not modify the parameter
 */
#ifdef __cplusplus
}
#endif

#endif // NVMEDIA_DLA_H