Data.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
// expressly authorized by NVIDIA.  Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2017 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 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 DW_SENSORS_DATA_DATA_H__
#define DW_SENSORS_DATA_DATA_H__

#include <dw/core/Config.h>
#include <dw/core/Types.h>

#include <dw/sensors/Sensors.h>

#pragma pack(push,1) // Make sure we have consistent structure packings

// maximum size of tranferred chunk in bytes
static const uint32_t DW_DATA_SENSOR_MAX_MEMORY_CHUNK_SIZE = 4096;

typedef struct {
    uint32_t    size;            
    uint64_t    timestamp;       
    const void  *data;           
} dwDataPacket;


#pragma pack(pop)

#ifdef __cplusplus
extern "C" {
#endif

DW_API_PUBLIC
dwStatus dwSensorData_readPacket(const dwDataPacket **packet, dwTime_t timeout_us,
                                  dwSensorHandle_t sensor);

DW_API_PUBLIC
dwStatus dwSensorData_returnPacket(const dwDataPacket *packet, dwSensorHandle_t sensor);


#ifdef __cplusplus
}
#endif

#endif // DW_SENSORS_DATA_DATA_H__