ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mbed-os/mbed.h

117 lines
3.2 KiB
C
Raw Normal View History

Initial commit of the mbed libraries and tools
2013-02-18 15:32:11 +00:00
/* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited
*
* 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 MBED_H
#define MBED_H
Separate version header file to get version updates in Mbed OS
2018-07-06 16:27:08 +00:00
#include "platform/mbed_version.h"
RTOS API for bare metal Provide partial RTOS API for bare metal builds - things that can be done in a single threaded environment. Allows more code to work in both RTOS and bare metal builds without change, and in particular gives easy access to the ability to efficiently wait for something occurring in interrupt. Available in bare-metal: * ThisThread * osThreadFlagsSet to set flags on main thread (can be set from IRQ) * EventFlags (can be set from IRQ) * Semaphores (can be released from IRQ) * Mutex (dummy implementation) Not useful: * ConditionVariable (could only be signalled from 2nd thread) * RtosTimer (calls in a second thread context) * Thread Unimplemented: * Mail, Queue, MemoryPool Possible future work: * ConditionVariableCS to act as IRQ signalled ConditionVariable
2019-03-14 11:36:02 +00:00
#if MBED_CONF_RTOS_API_PRESENT
restructure - Added single-nested inc_dir support to legacy build_lib Added single-nested include directories to libraries built with the legacy build_lib function. Unfortunately, to get this working without a significant rewrite of the legacy build tools, library header files are just duplicated in the precompile stage.
2016-10-01 18:34:57 +00:00
#include "rtos/rtos.h"
Includre rtos.h in mbed.h if present So that apps don't need to include "rtos.h" explicitly anymore.
2016-07-22 15:08:32 +00:00
#endif
Exposed the network-socket API through mbed.h Currently this uses the same mechanism used by the rtos to conditionally include the network-socket API. Perhaps this should be builtin to the config system? Note: this does require that the bug-compatible inclusion of mbed.h be removed to avoid include-order issues. per @sg-
2016-08-04 16:07:33 +00:00
#if MBED_CONF_NSAPI_PRESENT
restructure - Fixed include paths damaged by the restructure
2016-09-30 23:32:06 +00:00
#include "netsocket/nsapi.h"
Add APIs to namespace mbed Certain public APIs are being added to mbed.h so as to make them part of namespace mebd. APIs being added are: * drivers/UARTSerial.h * platform/ATCmdParser.h * platform/mbed_poll.h * netsocket/nsapi_ppp.h
2017-05-31 12:01:37 +00:00
#include "netsocket/nsapi_ppp.h"
Exposed the network-socket API through mbed.h Currently this uses the same mechanism used by the rtos to conditionally include the network-socket API. Perhaps this should be builtin to the config system? Note: this does require that the bug-compatible inclusion of mbed.h be removed to avoid include-order issues. per @sg-
2016-08-04 16:07:33 +00:00
#endif
Include events library headers in mbed.h The inclusion is conditioned by the presence of the events library (`MBED_CONF_EVENTS_PRESENT`). This ensures backward compatibility with SDK builds.
2016-09-30 14:12:00 +00:00
#if MBED_CONF_EVENTS_PRESENT
#include "events/mbed_events.h"
#endif
Filesystem: Integrate filesystem classes with common mbed.h entry point
2017-02-13 22:40:18 +00:00
#if MBED_CONF_FILESYSTEM_PRESENT
#include "filesystem/mbed_filesystem.h"
#endif
Renamed files in platform to match source names critical.h -> mbed_critical.h sleep.h -> mbed_sleep.h toolchain.h -> mbed_toolchain.h rtc_time.h -> mbed_rtc_time.h semihost_api.h -> mbed_semihost_api.h wait_api.h -> mbed_wait_api.h
2017-01-27 11:10:28 +00:00
#include "platform/mbed_toolchain.h"
For drivers, events, hal, platform, rtos and mbed.h add one level of path to make sure specific and unique includes files are found.
2016-10-01 07:11:36 +00:00
#include "platform/platform.h"
Add a function to transfer control to another app Add the function mbed_start_application() which allows a bootloader to transfer control to an application.
2017-02-08 22:17:14 +00:00
#include "platform/mbed_application.h"
Initial commit of the mbed libraries and tools
2013-02-18 15:32:11 +00:00
// Useful C libraries
#include <math.h>
#include <time.h>
// mbed Debug libraries
For drivers, events, hal, platform, rtos and mbed.h add one level of path to make sure specific and unique includes files are found.
2016-10-01 07:11:36 +00:00
#include "platform/mbed_error.h"
#include "platform/mbed_interface.h"
#include "platform/mbed_assert.h"
Include mbed_debug.h in mbed.h
2017-04-13 17:27:46 +00:00
#include "platform/mbed_debug.h"
Initial commit of the mbed libraries and tools
2013-02-18 15:32:11 +00:00
// mbed Peripheral components
For drivers, events, hal, platform, rtos and mbed.h add one level of path to make sure specific and unique includes files are found.
2016-10-01 07:11:36 +00:00
#include "drivers/DigitalIn.h"
#include "drivers/DigitalOut.h"
#include "drivers/DigitalInOut.h"
#include "drivers/BusIn.h"
#include "drivers/BusOut.h"
#include "drivers/BusInOut.h"
#include "drivers/PortIn.h"
#include "drivers/PortInOut.h"
#include "drivers/PortOut.h"
#include "drivers/AnalogIn.h"
#include "drivers/AnalogOut.h"
#include "drivers/PwmOut.h"
#include "drivers/SPI.h"
#include "drivers/SPISlave.h"
#include "drivers/I2C.h"
#include "drivers/I2CSlave.h"
#include "drivers/CAN.h"
UnbufferedSerial: Introduce the class to replace RawSerial * Deprecate RawSerial. * Introduce UnbufferedSerial to provide unbuffered I/O by implementing with a FileHandle interface for I/O streams. * Add Greentea test for the UnbufferedSerial class.
2019-10-18 15:39:25 +00:00
#include "drivers/UnbufferedSerial.h"
Implement the BufferedSerial class to replace UARTSerial `BufferedSerial` is `UARTSerial` renamed to convey the original purpose of the class.
2020-01-07 13:23:36 +00:00
#include "drivers/BufferedSerial.h"
flash: add FlashIAP class Flash IAP that provides erase/read/program to an internal API. It invokes flash HAL functions. FlashIAP checks for alignments for erase and program. HAL functions do not, to avoid duplication per target implementation.
2017-02-18 17:07:02 +00:00
#include "drivers/FlashIAP.h"
Moved specialized functions to CPP file Template specialized functions are moved to cpp file, to add MbedCRC.h in mbed.h. Else linker shall multiple definition error.
2018-02-20 14:05:12 +00:00
#include "drivers/MbedCRC.h"
Add QSPI header file in mbed.h
2018-10-11 19:40:42 +00:00
#include "drivers/QSPI.h"
mbed: add Watchdog and VirtualWatchdog
2019-06-27 12:08:28 +00:00
#include "drivers/Watchdog.h"
Initial commit of the mbed libraries and tools
2013-02-18 15:32:11 +00:00
// mbed Internal components
Add Watchdog and ResetReason headers to mbed.h Adding headers to mbed.h will prevent you having to manually include them when using the drivers in an application.
2018-03-27 13:31:23 +00:00
#include "drivers/ResetReason.h"
Add HighResClock and LowPowerClock
2020-03-03 14:48:40 +00:00
#include "drivers/HighResClock.h"
For drivers, events, hal, platform, rtos and mbed.h add one level of path to make sure specific and unique includes files are found.
2016-10-01 07:11:36 +00:00
#include "drivers/Timer.h"
#include "drivers/Ticker.h"
#include "drivers/Timeout.h"
Add HighResClock and LowPowerClock
2020-03-03 14:48:40 +00:00
#include "drivers/LowPowerClock.h"
For drivers, events, hal, platform, rtos and mbed.h add one level of path to make sure specific and unique includes files are found.
2016-10-01 07:11:36 +00:00
#include "drivers/LowPowerTimeout.h"
#include "drivers/LowPowerTicker.h"
#include "drivers/LowPowerTimer.h"
Add RealTimeClock
2020-02-25 12:34:14 +00:00
#include "drivers/RealTimeClock.h"
Filesystem: Moved retarget related file interfaces into platform
2017-03-07 16:40:37 +00:00
#include "platform/LocalFileSystem.h"
For drivers, events, hal, platform, rtos and mbed.h add one level of path to make sure specific and unique includes files are found.
2016-10-01 07:11:36 +00:00
#include "drivers/InterruptIn.h"
Renamed files in platform to match source names critical.h -> mbed_critical.h sleep.h -> mbed_sleep.h toolchain.h -> mbed_toolchain.h rtc_time.h -> mbed_rtc_time.h semihost_api.h -> mbed_semihost_api.h wait_api.h -> mbed_wait_api.h
2017-01-27 11:10:28 +00:00
#include "platform/mbed_wait_api.h"
Minimal C thread API
2019-03-14 15:08:30 +00:00
#include "platform/mbed_thread.h"
For drivers, events, hal, platform, rtos and mbed.h add one level of path to make sure specific and unique includes files are found.
2016-10-01 07:11:36 +00:00
#include "hal/sleep_api.h"
Move Atomic.h to <mstd_atomic> `mbed::Atomic<T>` becomes `mstd::atomic<T>`, alongside the other standard C++ library lookalikes.
2019-07-12 13:18:27 +00:00
#include "platform/mbed_atomic.h"
Add system_reset() function to Mbed OS
2018-02-27 15:25:16 +00:00
#include "platform/mbed_power_mgmt.h"
Renamed files in platform to match source names critical.h -> mbed_critical.h sleep.h -> mbed_sleep.h toolchain.h -> mbed_toolchain.h rtc_time.h -> mbed_rtc_time.h semihost_api.h -> mbed_semihost_api.h wait_api.h -> mbed_wait_api.h
2017-01-27 11:10:28 +00:00
#include "platform/mbed_rtc_time.h"
Add APIs to namespace mbed Certain public APIs are being added to mbed.h so as to make them part of namespace mebd. APIs being added are: * drivers/UARTSerial.h * platform/ATCmdParser.h * platform/mbed_poll.h * netsocket/nsapi_ppp.h
2017-05-31 12:01:37 +00:00
#include "platform/mbed_poll.h"
#include "platform/ATCmdParser.h"
FileSystem: Reintegrated FileSystemLike interface Required for other representations of FileSystems, ie LocalFileSystem Introduces FileSystemHandle for the same behaviour as FileHandle and DirHandle. Requires the following to hook into file/dir lookup: ``` int open(FileHandle **file, const char *filename, int flags) int open(DirHandle **dir, const char *path) ``` This hook is provided by the FileSystem class, so requires no changes from implementations.
2017-03-30 19:36:21 +00:00
#include "platform/FileSystemHandle.h"
#include "platform/FileHandle.h"
#include "platform/DirHandle.h"
platform: add CriticalSectionLock Critical section class RAII addition
2017-08-23 13:36:10 +00:00
#include "platform/CriticalSectionLock.h"
platform: add DeepSleepLock RAII object for disabling, then restoring the deep sleep mode
2017-08-23 13:28:41 +00:00
#include "platform/DeepSleepLock.h"
Rename lock functions and classes Invert the name of the lock functions and classes so you are not locking a negative.
2018-11-08 22:38:24 +00:00
#include "platform/ScopedRomWriteLock.h"
#include "platform/ScopedRamExecutionLock.h"
Add stats header file to mbed.h All API header files should be part of mbed.h
2018-05-02 19:15:01 +00:00
#include "platform/mbed_stats.h"
Initial commit of the mbed libraries and tools
2013-02-18 15:32:11 +00:00
Add Callback, an improved FunctionPointer class - Adopt C++11 style template arguments, requires rename to Callback - Add constructor for C style callback functions - Add constructor for Callbacks - Add static function for passing to C style callbacks
2016-05-13 19:54:46 +00:00
// mbed Non-hardware components
For drivers, events, hal, platform, rtos and mbed.h add one level of path to make sure specific and unique includes files are found.
2016-10-01 07:11:36 +00:00
#include "platform/Callback.h"
platform: Add ScopedLock
2018-01-15 06:58:05 +00:00
#include "platform/ScopedLock.h"
Add Callback, an improved FunctionPointer class - Adopt C++11 style template arguments, requires rename to Callback - Add constructor for C style callback functions - Add constructor for Callbacks - Add static function for passing to C style callbacks
2016-05-13 19:54:46 +00:00
MBED_NO_GLOBAL_USING_DIRECTIVE is added to remove auto-addition of namespace Macro guard `MBED_NO_GLOBAL_USING_DIRECTIVE` is added around namespace, to avoid polluting users namespace.
2018-10-25 15:45:29 +00:00
#ifndef MBED_NO_GLOBAL_USING_DIRECTIVE
Initial commit of the mbed libraries and tools
2013-02-18 15:32:11 +00:00
using namespace mbed;
using namespace std;
MBED_NO_GLOBAL_USING_DIRECTIVE is added to remove auto-addition of namespace Macro guard `MBED_NO_GLOBAL_USING_DIRECTIVE` is added around namespace, to avoid polluting users namespace.
2018-10-25 15:45:29 +00:00
#endif
Initial commit of the mbed libraries and tools
2013-02-18 15:32:11 +00:00
#endif