garnet/lib/magma/src/magma_util/platform/platform_sysmem_connection.h

// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef GARNET_LIB_MAGMA_SRC_MAGMA_UTIL_PLATFORM_PLATFORM_SYSMEM_CONNECTION_H_
#define GARNET_LIB_MAGMA_SRC_MAGMA_UTIL_PLATFORM_PLATFORM_SYSMEM_CONNECTION_H_

#include "magma.h"
#include "magma_sysmem.h"
#include "magma_util/status.h"
#include "platform_buffer.h"

#include <memory>

namespace magma_sysmem {
struct PlatformBufferDescription {
    bool is_secure = false;
    uint32_t count = 0;
    bool has_format_modifier = false;
    uint64_t format_modifier = 0u;
    uint32_t coherency_domain = MAGMA_COHERENCY_DOMAIN_CPU;
    magma_image_plane_t planes[MAGMA_MAX_IMAGE_PLANES] = {};
};

class PlatformBufferConstraints {
public:
    virtual ~PlatformBufferConstraints() {}

    virtual magma::Status
    SetImageFormatConstraints(uint32_t index,
                              const magma_image_format_constraints_t* format_constraints) = 0;
};

class PlatformBufferCollection {
public:
    virtual ~PlatformBufferCollection() {}

    virtual magma::Status SetConstraints(PlatformBufferConstraints* constraints) = 0;
    virtual magma::Status
    GetBufferDescription(std::unique_ptr<PlatformBufferDescription>* description_out) = 0;
    virtual magma::Status GetBufferHandle(uint32_t index, uint32_t* handle_out,
                                          uint32_t* offset_out) = 0;
};

class PlatformSysmemConnection {
public:
    virtual ~PlatformSysmemConnection() {}

    static std::unique_ptr<PlatformSysmemConnection> Create();

    static magma_status_t
    DecodeBufferDescription(const uint8_t* image_data, uint64_t image_data_size,
                            std::unique_ptr<PlatformBufferDescription>* buffer_description_out);

    virtual magma_status_t AllocateBuffer(uint32_t flags, size_t size,
                                          std::unique_ptr<magma::PlatformBuffer>* buffer_out) = 0;

    virtual magma::Status CreateBufferCollectionToken(uint32_t* handle_out) = 0;
    virtual magma::Status
    ImportBufferCollection(uint32_t handle,
                           std::unique_ptr<PlatformBufferCollection>* collection_out) = 0;

    virtual magma::Status
    CreateBufferConstraints(const magma_buffer_format_constraints_t* constraints,
                            std::unique_ptr<PlatformBufferConstraints>* constraints_out) = 0;
};

} // namespace magma_sysmem

#endif // GARNET_LIB_MAGMA_SRC_MAGMA_UTIL_PLATFORM_PLATFORM_SYSMEM_CONNECTION_H_