blob: 7b3262610cae0c6f1a4e9b9eb38bf31f6aaa7b52 [file] [log] [blame]
Kshitij Sisodiaa1256e32022-02-23 14:40:45 +00001/*
Richard Burtonf32a86a2022-11-15 11:46:11 +00002 * SPDX-FileCopyrightText: Copyright 2022 Arm Limited and/or its affiliates <open-source-office@arm.com>
Kshitij Sisodiaa1256e32022-02-23 14:40:45 +00003 * SPDX-License-Identifier: Apache-2.0
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#ifndef PLATFORM_DRIVERS_H
19#define PLATFORM_DRIVERS_H
20
21#include "log_macros.h" /* Logging related helpers. */
Kshitij Sisodiac22e80e2022-03-14 09:26:48 +000022#include "lcd_img.h" /* LCD functions */
23#include "user_input.h" /* User input function */
Kshitij Sisodiada2ec062022-04-01 14:43:53 +010024#include "timer_native.h" /* Native platform timer/profiler support */
Kshitij Sisodiaa1256e32022-02-23 14:40:45 +000025
26/**
27 * @brief Initialises the platform components.
28 * @return 0 if successful, error code otherwise.
29 */
30int platform_init(void);
31
32/**
33 * @brief Teardown for platform components.
34 */
35void platform_release(void);
36
37/**
Kshitij Sisodia4cc40212022-04-08 09:54:53 +010038 * @brief Gets the platform name.
39 * @return Pointer to the name
Kshitij Sisodiaa1256e32022-02-23 14:40:45 +000040 */
Kshitij Sisodia4cc40212022-04-08 09:54:53 +010041const char* platform_name(void);
Kshitij Sisodiaa1256e32022-02-23 14:40:45 +000042
43#endif /* PLATFORM_DRIVERS_H */