device.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2018, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */

#ifndef INCLUDED_DEVICE_H
#define INCLUDED_DEVICE_H

#include <nvcommon.h>
#ifndef QB_BL_BUILD
#include <flashtools_nverror.h>
#else
#include <nverror.h>
#endif
#include <device_id.h>

#define QB_MAX_DEV_INSTANCE 16
#define QB_MAX_DRIVER_TYPES 100

struct QbDev {
    QbDriver Driver;
    NvU32 Instance;
    void *DevInfo;
};

typedef enum
{
    QbDeviceStatus_None = 0,
    QbDeviceStatus_Idle,
    QbDeviceStatus_ReadInProgress,
    QbDeviceStatus_ReadFailure,
    QbDeviceStatus_WriteInProgress,
    QbDeviceStatus_WriteFailure,
    QbDeviceStatus_EccFailure,
    QbDeviceStatus_CorrectedEccFailure,
    QbDeviceStatus_DataCrcFailure,
    QbDeviceStatus_DataTimeout,
    QbDeviceStatus_DataEndBitError,
    QbDeviceStatus_CorrectedReadFailure,
    QbDeviceStatus_UnknownFailure,
    QbDeviceStatus_Max,
    QbDeviceStatus_Force32 = 0x7fffffff
} QbDeviceStatus;

struct QbDevOperations {
    NvError (*Probe)(struct QbDev *Dev);
    NvError (*Read)(QbDriver DriverType, NvU32 Instance, void *Buffer,
            NvU64 Size, NvU64 Offset);
    NvError (*Write)(QbDriver DriverType, NvU32 Instance, void *Buffer,
            NvU64 Size, NvU64 Offset);
    NvError (*Ioctl)(QbDriver DriverType, NvU32 Instance, NvU32 Cmd, void *Buf);
    NvError (*CleanExit)(QbDriver DriverType, NvU32 Instance);

    NvBool Initialized;

    NvBool DevInstanceIntialized[QB_MAX_DEV_INSTANCE];
};

NvError QbDeviceRead(QbDriver DriverType, NvU32 Instance,
                void *Buffer, NvU64 Size, NvU64 Offset);

NvError QbDevicePartRead(
            NvU32 PartitionId,
            void *Buffer,
            NvU64 Size,
            NvU64 Offset);

NvError QbDeviceWrite(
            QbDriver DriverType,
            NvU32 Instance,
            void *Buffer,
            NvU64 Size,
            NvU64 Offset);

NvError QbDevicePartWrite(
            NvU32 PartitionId,
            void *Buffer,
            NvU64 Size,
            NvU64 Offset);
NvError QbDeviceIoctl(
            QbDriver DriverType,
            NvU32 Instance,
            NvU32 Cmd,
            void *Buffer);

NvError QbCleanExit(QbDriver DriverType, NvU32 Instance);


NvError QbRegisterDriver(
            QbDriver Driver,
            struct QbDevOperations *pDevOps);

NvError QbRegisterDevice(struct QbDev *pDevice);

NvError QbLateRegisterDevice(QbDriver DriverType, NvU32 Instance);

NvBool QbIsDeviceRegistered(QbDriver DriverType, NvU32 Instance);

#endif //INCLUDED_DEVICE_H