libhal-mac

User space driver libraries for the Mac OSX operating system.

📚 Software APIs & Usage

To learn about available kernel APIs, documentation will be be made available soon.

To see some example code on how various APIs are used, see the programs inside the demos folder.

🧰 Setup

Following the 🚀 Getting Started instructions.

🏗️ Building Demos

All applications must be built on a mac to get a suitable binary.

The demos use the latest version of the libhal-mac package to work. Before you can build the demos you need to create the latest package:

conan create . -pr:a hal/tc/llvm

Note

By not specifying a --version, the version latest is choosen.

Now you can build demos by running the following command:

conan build demos -pr:a hal/tc/llvm

Note

GCC is not currently supported.

If you'd like to make a minimum sized binary or a debug binary use the following commands:

# For minimum sized binaries (optimized for small code size)
conan build demos -pr:a hal/tc/llvm -s build_type=MinSizeRel

# For debug binaries (low optimization)
conan build demos -pr:a hal/tc/llvm -s build_type=Debug

We default to Release builds when building for Mac OSX. By default the binaries will be built in the ./demos/build/mac/Release directory. There you can find your executables and build artifacts. For MinSizeRel the binaries will be in ./demos/build/mac/MinSizeRel. For Debug the binaries will be in ./demos/build/mac/Debug.

💾 Executing Programs

To execute the program simply run the following:

For Release builds:

./demos/build/mac/Release/mac_demos_serial

For MinSizeRel builds:

./demos/build/mac/MinSizeRel/mac_demos_serial

For Debug builds:

./demos/build/mac/Debug/mac_demos_serial

Contributing

See CONTRIBUTING.md for details.

License

Apache 2.0; see LICENSE for details.