sivc-instance.h

Go to the documentation of this file.

//
// SPDX-FileCopyrightText: Copyright (c) 2019-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//
 
#ifndef SIVC_INSTANCE_H
#define SIVC_INSTANCE_H
 
#ifdef __cplusplus
#include <cstddef>
#include <cstdint>
#else
#include <stddef.h>
#include <stdint.h>
#endif
 
#include "ivclib-static-analysis.h"
#include "ivclib-fwd-decl.h"
 
#define SIVC_ALIGN_SHIFT 6U
 
#ifdef __cplusplus
#define SIVC_ALIGN       (static_cast<uint32_t>(1U) << SIVC_ALIGN_SHIFT)
namespace Ivc {
extern "C" {
#else
#define SIVC_ALIGN       (((uint32_t)1U) << SIVC_ALIGN_SHIFT)
#endif
 
uint32_t sivc_align(uint32_t value);
 
uint32_t sivc_fifo_size(uint32_t nframes, uint32_t frame_size);
 
struct sivc_fifo_header;
 
typedef void (*sivc_notify_function)(struct sivc_queue* queue);
 
// STAN: It is necessary to use 'volatile' here to prevent optimization, as the data may be modified
// externally.
typedef void (*sivc_cache_invalidate_function)(const volatile void* addr,
        size_t size);
 
// STAN: It is necessary to use 'volatile' here to prevent optimization, as the data may be modified
// externally.
typedef void (*sivc_cache_flush_function)(const volatile void* addr,
        size_t size);
 
/* WARNING: This structure is a part of private IVC interface.
 *          You should not access any of its member directly. Please use helper
 *          functions instead.
 *          See sivc_get_nframes() and sivc_get_frame_size().
 */
// STAN: It is necessary to use 'volatile' here to prevent optimization, as the data may be modified
// externally.
struct sivc_queue {
    volatile struct sivc_fifo_header* recv_fifo;
    volatile struct sivc_fifo_header* send_fifo;
    uint32_t w_pos;
    uint32_t r_pos;
    uint32_t nframes;
    uint32_t frame_size;
    sivc_notify_function notify;
    sivc_cache_invalidate_function mem_cache_invalidate;
    sivc_cache_flush_function mem_cache_flush;
};
 
int sivc_init(struct sivc_queue* queue,
        uintptr_t recv_base, uintptr_t send_base,
        uint32_t nframes, uint32_t frame_size, sivc_notify_function notify,
        sivc_cache_invalidate_function cache_invalidate,
        sivc_cache_flush_function sivc_cache_flush);
 
#ifdef __cplusplus
} // extern "C"
} // namespace Ivc
#endif
 
#endif // SIVC_INSTANCE_H