platform/freertos/include/chre/target_platform/init.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_INIT_H_
#define CHRE_PLATFORM_FREERTOS_INIT_H_

#include "FreeRTOS.h"

namespace chre {
namespace freertos {

/**
 * This init function spawns a (non-privileged) FreeRTOS task that
 * initializes the CHRE core, loads any static nanoapps, and starts
 * the CHRE event loop.
 * The task attribute constants are located in the corresponding init.cc
 * source file, in case they need to be altered. The defaults chosen are:
 * - Task Stack Depth: 8K Words
 * - Task Priority: 1 (idle_task + 1)
 *
 * @return pdPASS on success, a FreeRTOS error code otherwise.
 */
BaseType_t init();

/**
 * Delete the task spawned in the init function
 */
void deinit();

}  // namespace freertos
}  // namespace chre

#endif  // CHRE_PLATFORM_FREERTOS_INIT_H_