alexander | 3c79893 | 2021-03-26 21:42:19 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2021 Arm Limited. All rights reserved. |
| 3 | * 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 | #ifndef BAREMETAL_SYSTEM_INIT_H |
| 18 | #define BAREMETAL_SYSTEM_INIT_H |
| 19 | |
| 20 | #include "bsp.h" |
| 21 | |
| 22 | /** |
| 23 | * @brief Initialises the platform (MPS3 FPGA board or Fixed Virtual Platform) |
| 24 | * Updates the system core clock and initialises the UART. It also |
| 25 | * verifies that the Cortex-M CPU variant being used matches the expected |
| 26 | * value if running on MPS3. |
| 27 | * @return 0 if successful, error code otherwise. |
| 28 | */ |
| 29 | int system_init(void); |
| 30 | |
| 31 | /** |
| 32 | * @brief Releases the platform (MPS3 FPGA board or Fixed Virtual Platform). |
| 33 | **/ |
| 34 | void system_release(void); |
| 35 | |
| 36 | /** |
| 37 | * @brief Return the name the platform (MPS3 FPGA board or Fixed Virtual Platform). |
| 38 | * @param[out] name Platform name string. |
| 39 | * @param[in] size Name string length. |
| 40 | **/ |
| 41 | void system_name(char* name, size_t size); |
| 42 | |
| 43 | #endif /* BAREMETAL_SYSTEM_INIT_H */ |