nvrm_gpusched.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 NVIDIA Corporation.  All Rights Reserved.
 *
 * NVIDIA Corporation and its licensors retain all intellectual property and
 * proprietary rights in and to this software and related documentation.  Any
 * use, reproduction, disclosure or distribution of this software and related
 * documentation without an express license agreement from NVIDIA Corporation
 * is strictly prohibited.
 */
 
#ifndef NVRM_GPUSCHED_H
#define NVRM_GPUSCHED_H
 
#include <sys/types.h>
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef uint32_t NvRmGpuSchedTsgId;
typedef struct NvRmGpuSchedSessionRec NvRmGpuSchedSession;
typedef struct NvRmGpuSchedTsgRec NvRmGpuSchedTsg;
typedef struct NvRmGpuSchedTsgSetRec NvRmGpuSchedTsgSet;
 
typedef enum {
    NVRM_GPUSCHED_STATUS_OK = 0,
    NVRM_GPUSCHED_STATUS_BAD_PARAMETER,
    NVRM_GPUSCHED_STATUS_PENDING,
    NVRM_GPUSCHED_STATUS_TIMED_OUT,
    NVRM_GPUSCHED_STATUS_OUT_OF_MEMORY,
    NVRM_GPUSCHED_STATUS_NOT_INITIALIZED,
    NVRM_GPUSCHED_STATUS_NOT_SUPPORTED,
    NVRM_GPUSCHED_STATUS_ERROR,
    NVRM_GPUSCHED_STATUS_NONE_PENDING,
    NVRM_GPUSCHED_STATUS_INSUFFICIENT_BUFFERING,
    NVRM_GPUSCHED_STATUS_INVALID_SIZE,
    NVRM_GPUSCHED_STATUS_INCOMPATIBLE_VERSION,
} NvRmGpuSchedStatus;
 
typedef enum
{
    NVRM_GPUSCHED_TSG_EVENT_OPEN = (1ULL << 0),
} NvRmGpuSchedTsgEvents;
 
typedef enum {
    NVRM_GPUSCHED_RUNLIST_INTERLEAVE_LOW = 1,
    NVRM_GPUSCHED_RUNLIST_INTERLEAVE_MEDIUM = 2,
    NVRM_GPUSCHED_RUNLIST_INTERLEAVE_HIGH = 3,
} NvRmGpuSchedRunlistInterleave;
 
typedef struct NvRmGpuSchedTsgParamsRec {
    NvRmGpuSchedTsgId tsgid;
    NvRmGpuSchedRunlistInterleave interleave;
    uint32_t timesliceUs;
    pid_t pid;
} NvRmGpuSchedTsgParams;
 
typedef struct NvRmGpuSchedSessionAttrRec
{
    uint32_t reserved;
} NvRmGpuSchedSessionAttr;
 
#define NVRM_GPUSCHED_DEFINE_SESSION_ATTR(x) \
    NvRmGpuSchedSessionAttr x = { 0 }
 
#define NVRM_GPUSCHED_WAIT_INFINITE ((uint32_t)-1)
 
NvRmGpuSchedStatus NvRmGpuSchedSessionOpen(
    const NvRmGpuSchedSessionAttr *attr,
    NvRmGpuSchedSession **phSession);
 
void NvRmGpuSchedSessionClose(NvRmGpuSchedSession *hSession);
 
NvRmGpuSchedStatus NvRmGpuSchedWaitTsgEvents(
    NvRmGpuSchedSession *hSession,
    NvRmGpuSchedTsgEvents *events,
    uint32_t timeout);
 
NvRmGpuSchedStatus NvRmGpuSchedGetAllActiveTsgs(
    NvRmGpuSchedTsgSet *hTsgSet);
 
NvRmGpuSchedStatus NvRmGpuSchedGetDeltaTsgs(
    NvRmGpuSchedTsgSet *hTsgSet);
 
NvRmGpuSchedStatus NvRmGpuSchedGetTsgsByPid(
    NvRmGpuSchedTsgSet *hTsgSet,
    pid_t pid);
 
NvRmGpuSchedStatus NvRmGpuSchedGetNextTsgId(
    NvRmGpuSchedTsgSet *hTsgSet,
    NvRmGpuSchedTsgId *tsgid);
 
NvRmGpuSchedStatus NvRmGpuSchedGetTsgHandle(
    NvRmGpuSchedSession *hSession,
    NvRmGpuSchedTsgId tsgid,
    NvRmGpuSchedTsg **phTsg);
 
NvRmGpuSchedStatus NvRmGpuSchedGetTsgParams(
    NvRmGpuSchedTsg *hTsg,
    NvRmGpuSchedTsgParams *params);
 
NvRmGpuSchedStatus NvRmGpuSchedSetTsgInterleave(
    NvRmGpuSchedTsg *hTsg,
    NvRmGpuSchedRunlistInterleave interleave);
 
NvRmGpuSchedStatus NvRmGpuSchedSetTsgTimeslice(
    NvRmGpuSchedTsg *hTsg,
    uint32_t timeslice);
 
NvRmGpuSchedStatus NvRmGpuSchedReleaseTsgHandle(
    NvRmGpuSchedTsg *hTsg);
 
NvRmGpuSchedStatus NvRmGpuSchedLockControl(
    NvRmGpuSchedSession *hSession);
 
NvRmGpuSchedStatus NvRmGpuSchedUnlockControl(
    NvRmGpuSchedSession *hSession);
 
NvRmGpuSchedStatus NvRmGpuSchedAllocateTsgSet(
    NvRmGpuSchedSession *hSession,
    NvRmGpuSchedTsgSet **phSet);
 
void NvRmGpuSchedFreeTsgSet(
    NvRmGpuSchedTsgSet *hSet);
 
 
#ifdef __cplusplus
};  /* end of extern "C" */
#endif /* __cplusplus */
 
#endif /* NVRM_GPUSCHED_H */