Kev Mann / mbed-dev-OS5_10_4

RTC auf true

rtos/TARGET_CORTEX/mbed_boot.h@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kevman 0:38ceb79fef03 1 /* mbed Microcontroller Library
kevman 0:38ceb79fef03 2 * Copyright (c) 2018-2018 ARM Limited
kevman 0:38ceb79fef03 3 *
kevman 0:38ceb79fef03 4 * Licensed under the Apache License, Version 2.0 (the "License");
kevman 0:38ceb79fef03 5 * you may not use this file except in compliance with the License.
kevman 0:38ceb79fef03 6 * You may obtain a copy of the License at
kevman 0:38ceb79fef03 7 *
kevman 0:38ceb79fef03 8 * http://www.apache.org/licenses/LICENSE-2.0
kevman 0:38ceb79fef03 9 *
kevman 0:38ceb79fef03 10 * Unless required by applicable law or agreed to in writing, software
kevman 0:38ceb79fef03 11 * distributed under the License is distributed on an "AS IS" BASIS,
kevman 0:38ceb79fef03 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kevman 0:38ceb79fef03 13 * See the License for the specific language governing permissions and
kevman 0:38ceb79fef03 14 * limitations under the License.
kevman 0:38ceb79fef03 15 */
kevman 0:38ceb79fef03 16 #ifndef MBED_BOOT_H
kevman 0:38ceb79fef03 17 #define MBED_BOOT_H
kevman 0:38ceb79fef03 18
kevman 0:38ceb79fef03 19 #include "mbed_toolchain.h"
kevman 0:38ceb79fef03 20
kevman 0:38ceb79fef03 21 #ifdef __cplusplus
kevman 0:38ceb79fef03 22 extern "C" {
kevman 0:38ceb79fef03 23 #endif
kevman 0:38ceb79fef03 24
kevman 0:38ceb79fef03 25 #include "mbed_rtx.h"
kevman 0:38ceb79fef03 26
kevman 0:38ceb79fef03 27 /**
kevman 0:38ceb79fef03 28 * \defgroup boot Boot sequence
kevman 0:38ceb79fef03 29 * Boot sequence overview
kevman 0:38ceb79fef03 30 *
kevman 0:38ceb79fef03 31 * 1. Setup target
kevman 0:38ceb79fef03 32 * - Configure clocks
kevman 0:38ceb79fef03 33 * - Configure watchdog (if applicable)
kevman 0:38ceb79fef03 34 * - Turn on RAM (if applicable)
kevman 0:38ceb79fef03 35 * - Jump to setup toolchain
kevman 0:38ceb79fef03 36 * 2. Setup toolchain
kevman 0:38ceb79fef03 37 * - Initialize RAM
kevman 0:38ceb79fef03 38 * - Initialize standard library
kevman 0:38ceb79fef03 39 * - Call mbed_init
kevman 0:38ceb79fef03 40 * - jump to start rtos
kevman 0:38ceb79fef03 41 * 3. Start RTOS
kevman 0:38ceb79fef03 42 * - Create main thread
kevman 0:38ceb79fef03 43 * - Start scheduler
kevman 0:38ceb79fef03 44 * - main thread calls start mbed
kevman 0:38ceb79fef03 45 * 4. Start mbed
kevman 0:38ceb79fef03 46 * - Call mbed_main
kevman 0:38ceb79fef03 47 * - Call main
kevman 0:38ceb79fef03 48 *
kevman 0:38ceb79fef03 49 * @{
kevman 0:38ceb79fef03 50 */
kevman 0:38ceb79fef03 51
kevman 0:38ceb79fef03 52 /* Define stack sizes if they haven't been set already */
kevman 0:38ceb79fef03 53 #if !defined(ISR_STACK_SIZE)
kevman 0:38ceb79fef03 54 #define ISR_STACK_SIZE ((uint32_t)1024)
kevman 0:38ceb79fef03 55 #endif
kevman 0:38ceb79fef03 56
kevman 0:38ceb79fef03 57 /* Heap limits - only used if set */
kevman 0:38ceb79fef03 58 extern unsigned char *mbed_heap_start;
kevman 0:38ceb79fef03 59 extern uint32_t mbed_heap_size;
kevman 0:38ceb79fef03 60
kevman 0:38ceb79fef03 61 /* Stack limits */
kevman 0:38ceb79fef03 62 extern unsigned char *mbed_stack_isr_start;
kevman 0:38ceb79fef03 63 extern uint32_t mbed_stack_isr_size;
kevman 0:38ceb79fef03 64
kevman 0:38ceb79fef03 65 /**
kevman 0:38ceb79fef03 66 * Perform low level init of mbed
kevman 0:38ceb79fef03 67 *
kevman 0:38ceb79fef03 68 * The toolchain calls this function as part of the boot
kevman 0:38ceb79fef03 69 * sequence. This function does the following:
kevman 0:38ceb79fef03 70 * - Sets up NVIC so interrupts can be used
kevman 0:38ceb79fef03 71 * - Calls into the vendor SDK so it can be used
kevman 0:38ceb79fef03 72 * - Initializes the RTOS so it can be used
kevman 0:38ceb79fef03 73 *
kevman 0:38ceb79fef03 74 * Preconditions:
kevman 0:38ceb79fef03 75 * - Target is initialized
kevman 0:38ceb79fef03 76 * - Ram is initialized
kevman 0:38ceb79fef03 77 * - value set for mbed_heap_start
kevman 0:38ceb79fef03 78 * - value set for mbed_heap_size
kevman 0:38ceb79fef03 79 * - value set for mbed_stack_isr_start
kevman 0:38ceb79fef03 80 * - value set for mbed_stack_isr_size
kevman 0:38ceb79fef03 81 *
kevman 0:38ceb79fef03 82 * The following events must not have happened yet:
kevman 0:38ceb79fef03 83 * - global constructors must not be called yet
kevman 0:38ceb79fef03 84 *
kevman 0:38ceb79fef03 85 */
kevman 0:38ceb79fef03 86 void mbed_init(void);
kevman 0:38ceb79fef03 87
kevman 0:38ceb79fef03 88 /**
kevman 0:38ceb79fef03 89 * Start the main mbed application
kevman 0:38ceb79fef03 90 *
kevman 0:38ceb79fef03 91 * This is the last stage of the boot sequence. This function must be
kevman 0:38ceb79fef03 92 * called only after the RTOS has been fully initialized.
kevman 0:38ceb79fef03 93 * This function does the following:
kevman 0:38ceb79fef03 94 * - Initialize the toolchain
kevman 0:38ceb79fef03 95 * - Run mbed_main
kevman 0:38ceb79fef03 96 * - Run main
kevman 0:38ceb79fef03 97 *
kevman 0:38ceb79fef03 98 * Preconditions:
kevman 0:38ceb79fef03 99 * - The RTOS has been started by a call to mbed_rtos_start
kevman 0:38ceb79fef03 100 *
kevman 0:38ceb79fef03 101 */
kevman 0:38ceb79fef03 102 void mbed_start(void);
kevman 0:38ceb79fef03 103
kevman 0:38ceb79fef03 104 /**
kevman 0:38ceb79fef03 105 * Perform low level initialization of the RTOS
kevman 0:38ceb79fef03 106 *
kevman 0:38ceb79fef03 107 * Set the RTOS to a known state but don't start the scheduler. After
kevman 0:38ceb79fef03 108 * the RTOS has been initialized it is safe to create RTOS primitives
kevman 0:38ceb79fef03 109 * for file locks or other purposes.
kevman 0:38ceb79fef03 110 *
kevman 0:38ceb79fef03 111 * Preconditions:
kevman 0:38ceb79fef03 112 * - Ram is initialized
kevman 0:38ceb79fef03 113 * - NVIC is setup
kevman 0:38ceb79fef03 114 * - Vendor SDK must be initialized by a call to mbed_sdk_init
kevman 0:38ceb79fef03 115 */
kevman 0:38ceb79fef03 116 void mbed_rtos_init(void);
kevman 0:38ceb79fef03 117
kevman 0:38ceb79fef03 118 /**
kevman 0:38ceb79fef03 119 * Start the RTOS
kevman 0:38ceb79fef03 120 *
kevman 0:38ceb79fef03 121 * Start the RTOS scheduler and call mbed_start on the
kevman 0:38ceb79fef03 122 * main thread. This function does not return.
kevman 0:38ceb79fef03 123 *
kevman 0:38ceb79fef03 124 * Preconditions:
kevman 0:38ceb79fef03 125 * - RTOS has been initialized by a call to mbed_rtos_init
kevman 0:38ceb79fef03 126 */
kevman 0:38ceb79fef03 127 MBED_NORETURN void mbed_rtos_start(void);
kevman 0:38ceb79fef03 128
kevman 0:38ceb79fef03 129 /**
kevman 0:38ceb79fef03 130 * Perform toolchain specific initialization
kevman 0:38ceb79fef03 131 *
kevman 0:38ceb79fef03 132 * Initialize locks if this has not been done already
kevman 0:38ceb79fef03 133 * and call global C++ constructors.
kevman 0:38ceb79fef03 134 *
kevman 0:38ceb79fef03 135 * Preconditions:
kevman 0:38ceb79fef03 136 * - The RTOS has been started by a call to mbed_rtos_start
kevman 0:38ceb79fef03 137 */
kevman 0:38ceb79fef03 138 void mbed_toolchain_init(void);
kevman 0:38ceb79fef03 139
kevman 0:38ceb79fef03 140 /**
kevman 0:38ceb79fef03 141 * SDK hook for running code before ctors or OS
kevman 0:38ceb79fef03 142 *
kevman 0:38ceb79fef03 143 * This is a weak function which can be overridden by a target's
kevman 0:38ceb79fef03 144 * SDK to allow code to run after ram is initialized but before
kevman 0:38ceb79fef03 145 * the OS has been started or constructors have run.
kevman 0:38ceb79fef03 146 *
kevman 0:38ceb79fef03 147 * Preconditions:
kevman 0:38ceb79fef03 148 * - Ram is initialized
kevman 0:38ceb79fef03 149 * - NVIC is setup
kevman 0:38ceb79fef03 150 */
kevman 0:38ceb79fef03 151 void mbed_sdk_init(void);
kevman 0:38ceb79fef03 152
kevman 0:38ceb79fef03 153 /**
kevman 0:38ceb79fef03 154 * Application hook for running code before main
kevman 0:38ceb79fef03 155 *
kevman 0:38ceb79fef03 156 * This is a weak function which can be overridden by an application
kevman 0:38ceb79fef03 157 * to allow code to run before main is called.
kevman 0:38ceb79fef03 158 *
kevman 0:38ceb79fef03 159 * Preconditions:
kevman 0:38ceb79fef03 160 * - The RTOS has been started by a call to mbed_rtos_start
kevman 0:38ceb79fef03 161 * - The toolchain has been initialized by a call to mbed_toolchain_init
kevman 0:38ceb79fef03 162 */
kevman 0:38ceb79fef03 163 void mbed_main(void);
kevman 0:38ceb79fef03 164
kevman 0:38ceb79fef03 165 /**@}*/
kevman 0:38ceb79fef03 166
kevman 0:38ceb79fef03 167 #ifdef __cplusplus
kevman 0:38ceb79fef03 168 }
kevman 0:38ceb79fef03 169 #endif
kevman 0:38ceb79fef03 170
kevman 0:38ceb79fef03 171 #endif /* MBED_BOOT_H */