Ram Gandikota / Mbed OS ABCD

A metronome using the FRDM K64F board

pal/README.md@0:a7a43371b306, 2017-05-14 (annotated)

Committer:
ram54288
Date:
Sun May 14 18:40:18 2017 +0000
Revision:
0:a7a43371b306
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ram54288 0:a7a43371b306 1 # PAL
ram54288 0:a7a43371b306 2 This is the main repository for the Platform Abstraction Layer (PAL) project.
ram54288 0:a7a43371b306 3
ram54288 0:a7a43371b306 4 # Releases
ram54288 0:a7a43371b306 5
ram54288 0:a7a43371b306 6 In order to get the latest stable and tested code, plesae goto [releases](https://github.com/ARMmbed/mbed-client-pal/releases)
ram54288 0:a7a43371b306 7 and download the required release version - each release has a comment regarding which official mbedOS version was used for
ram54288 0:a7a43371b306 8 development and testing.
ram54288 0:a7a43371b306 9
ram54288 0:a7a43371b306 10
ram54288 0:a7a43371b306 11 # General Use Notes
ram54288 0:a7a43371b306 12
ram54288 0:a7a43371b306 13 * `pal_init()` API MUST be called before using any other PAL API, calling PAL APIs without
ram54288 0:a7a43371b306 14 initialization PAL can return with initialization error.
ram54288 0:a7a43371b306 15 * `pal_destroy()` API MUST ba called to free any allocated resources by PAL Modules.
ram54288 0:a7a43371b306 16
ram54288 0:a7a43371b306 17
ram54288 0:a7a43371b306 18 # How To Build PAL Tests
ram54288 0:a7a43371b306 19 ## MbedOS
ram54288 0:a7a43371b306 20
ram54288 0:a7a43371b306 21 1. Define the environment variable: `MBEDOS_ROOT` to be the father folder of "mbed-os".
ram54288 0:a7a43371b306 22 2. `cd $(PAL_FOLDER)/Test/`
ram54288 0:a7a43371b306 23 3. make mbedOS_all - This will build the tests for mbedOS5.2 (mbed-os-5.2)over Freescale-K64F board.
ram54288 0:a7a43371b306 24 4. In order to build and run the tests over the platform please run:
ram54288 0:a7a43371b306 25
ram54288 0:a7a43371b306 26 $ make mbedOS_check
ram54288 0:a7a43371b306 27
ram54288 0:a7a43371b306 28 5. In order to see debug prints please send the following flag `DEBUG=1` in compilation command:
ram54288 0:a7a43371b306 29
ram54288 0:a7a43371b306 30 $ make mbedOS_check DEBUG=1
ram54288 0:a7a43371b306 31
ram54288 0:a7a43371b306 32 6. In order to build single module tests please edit `$(PAL_FOLDER)/Test/makefile`
ram54288 0:a7a43371b306 33 under mbedOS5.1 platform, please change the value of the `TARGET_CONFIGURATION_DEFINES` to the
ram54288 0:a7a43371b306 34 desired module: (default value is for all exist modules)
ram54288 0:a7a43371b306 35
ram54288 0:a7a43371b306 36 HAS_RTOS --> RTOS module APIs
ram54288 0:a7a43371b306 37 HAS_SOCKET --> Networking module APIs
ram54288 0:a7a43371b306 38
ram54288 0:a7a43371b306 39
ram54288 0:a7a43371b306 40
ram54288 0:a7a43371b306 41 # PAL Repository Directory structure
ram54288 0:a7a43371b306 42 ```
ram54288 0:a7a43371b306 43 │
ram54288 0:a7a43371b306 44 ├── Build //Auto generated during build folder
ram54288 0:a7a43371b306 45 │   └── mbedOS //inncludes .a files
ram54288 0:a7a43371b306 46 │   └── obj //includes obj files
ram54288 0:a7a43371b306 47 │
ram54288 0:a7a43371b306 48 ├── Docs
ram54288 0:a7a43371b306 49 │
ram54288 0:a7a43371b306 50 ├── Examples
ram54288 0:a7a43371b306 51 │
ram54288 0:a7a43371b306 52 ├── Source
ram54288 0:a7a43371b306 53 │   ├── PAL-Impl
ram54288 0:a7a43371b306 54 │   │   ├── Modules
ram54288 0:a7a43371b306 55 │   │   │   ├── Networking
ram54288 0:a7a43371b306 56 │   │   │   ├── RTOS
ram54288 0:a7a43371b306 57 │   │   │   └── Update
ram54288 0:a7a43371b306 58 │   │   ├── Services-API //High level Services API for mbed-client to call
ram54288 0:a7a43371b306 59 │   │   └── pal_init.c //this file contains the global PAL initialization function
ram54288 0:a7a43371b306 60 │ │
ram54288 0:a7a43371b306 61 │   └── Port
ram54288 0:a7a43371b306 62 │   | ├── Platform-API //Low level platform oriented API for cutomer to implement
ram54288 0:a7a43371b306 63 │   | └── Reference-Impl
ram54288 0:a7a43371b306 64 │   | | └── mbedOS
ram54288 0:a7a43371b306 65 │   | | | ├── Networking
ram54288 0:a7a43371b306 66 │   | | | ├── RTOS
ram54288 0:a7a43371b306 67 │   | | | └── Update
ram54288 0:a7a43371b306 68 │
ram54288 0:a7a43371b306 69 ├── Test
ram54288 0:a7a43371b306 70 │   ├── Common //contains common headers for tests
ram54288 0:a7a43371b306 71 │   ├── Scripts
ram54288 0:a7a43371b306 72 │   ├── Unitest //contains the Unitests source code for each module (RTOS, Update, etc)
ram54288 0:a7a43371b306 73 │   └── Unity //contains the Unity framework source code
ram54288 0:a7a43371b306 74 │
ram54288 0:a7a43371b306 75 ├── Utils
ram54288 0:a7a43371b306 76 │ └── Scripts
ram54288 0:a7a43371b306 77 │
ram54288 0:a7a43371b306 78 ├── PAL MakeFile
ram54288 0:a7a43371b306 79 ├── Project editor proj file
ram54288 0:a7a43371b306 80 ├── PAL Master Build Script
ram54288 0:a7a43371b306 81 └── Main index Readme file
ram54288 0:a7a43371b306 82
ram54288 0:a7a43371b306 83 ```
ram54288 0:a7a43371b306 84