platform/freertos/include/chre/platform/freertos/memory.h

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef CHRE_PLATFORM_FREERTOS_MEMORY_H_
#define CHRE_PLATFORM_FREERTOS_MEMORY_H_

#include <cstddef>

namespace chre {

/**
 * Aligned memory allocation specifically using the DRAM heap. The semantics are
 * the same as malloc.
 *
 * If DRAM or another large memory capacity region is not available, this will
 * allocate from the same memory region as memoryAlloc.
 */
void *memoryAllocDramAligned(size_t alignment, size_t size);

/**
 * Memory allocation specifically using the DRAM heap. The semantics are the
 * same as malloc.
 *
 * If DRAM or another large memory capacity region is not available, this will
 * allocate from the same memory region as memoryAlloc.
 */
void *memoryAllocDram(size_t size);

/**
 * Memory free from memory allocated using the DRAM heap. The semantics are the
 * same as free.
 *
 * If DRAM or another large memory capacity region is not available, this will
 * free from the same memory region as memoryFree.
 */
void memoryFreeDram(void *pointer);

/**
 * Requests or releases access to DRAM or another large capacity region, if
 * available. If not such region exists, this method should return true and be a
 * no-op.
 */
bool requestDramAccess(bool enabled);

}  // namespace chre

#endif  // CHRE_PLATFORM_FREERTOS_MEMORY_H_