Skip to content

Latest commit

 

History

History
200 lines (123 loc) · 11.8 KB

README.md

File metadata and controls

200 lines (123 loc) · 11.8 KB
Raw

Catena-mcciadk

This repository contains the MCCI® ADK, a version of the MCCI XDK adapted for use on Catena®-like Arduinos by MCCI Corporation.

GitHub release GitHub commits Build Status

Contents:

Introduction

MCCI uses its XDK (cross-platform development kit) for writing portable code for use across development environments, compilers and operating systems. Although we don't think it's really appropriate for Arduino work, we find some of its idioms extremely useful, along with some of the functions.

By convention, MCCI makes specific versions of development environments for different targets. We have, for example, a "MCCI WDK" library for use in with the Microsoft Windows Driver Development Kit; we have an "LDK" library for use with the Linux kernel; and we have a "PDK" library for use in portable POSIX application development. All share basic features with the XDK. So it made sense to us to create an "Arduino Development Kit" ("ADK") that makes it easy to bring in other MCCI code to Arduino environments.

Some of these macros represent ways of dealing with portability that actually are not applicable in the Arduino environment. However, we use them anyway.

  • MCCI has lots of code that use these constructs, and it's easier (and more reliable) to port in the code using the macros.
  • If we use these macros, we can quickly port code that we develop in the Arduino environment to our other xDKs.
  • We're used to this style, and so we can focus on the tasks at hand.

There are two parts to the ADK:

  • header files and compile-time helpers
  • library routines

We'll discuss them in turn.

mcciadk_env.h

This header file sets up a common compile-time environment.

Library versions

  • MCCIADK_VERSION is the current library version, as computed by MCCIADK_VERSION_CALC()
  • MCCIADK_VERSION_CALC(major, minor, patch, local) calculates a 32-bit integer based on the Semantic Version v2.0 info given by major, minor, patch, and local. Each field is an integer in the range 0..255. The integers returned are guaranteed to compare arithmetically in the same order expected by a semantic version comparison.
  • MCCIADK_VERSION_GET_MAJOR(version) returns the major number field of version.
  • MCCIADK_VERSION_GET_MINOR(version) returns the minor number field of version.
  • MCCIADK_VERSION_GET_PATCH(version) returns the patch number field of version.
  • MCCIADK_VERSION_GET_LOCAL(version) returns the local number field of version.

Compile-time text manipulation

  • MCCIADK_STRING(sym) returns sym as a string, without macro expansion.
  • MCCIADK_STRINGVAL(sym) returns sym as a string, after macro expansion.
  • MCCIADK_CONCAT(a, b) returns ab as a single token, without macro expansion.
  • MCCIADK_CONCAT3(a, b, c), returns abc as a single token, without macro expansion.
  • MCCIADK_CONCATVAL3(a, b, c), returns abc as a single token, after macro expansion.

Value Computation

  • MCCIADK_CONTAINER_OF(innerPointer, OuterType, innerFieldName): given a pointer to a field in a larger structure, the type of the larger structure, and the name of the inner field, MCCIADK_CONTAINER_OF() returns a pointer of type OuterType pointing to the larger structure.

  • MCCIADK_MEMTAG(): generates a consistent memory tag (with controlled byte order) from a four-byte sequence. Often used to tag data structures to assist with port-mortem crash analysis.

  • MCCIADK_LENOF(array): returns the number of elements in the array (as opposed to sizeof(array), which returns the number of bytes in the array).

Static Assert

  • MCCIADK_C_ASSERT(constExpr): this is the equivalent of C++- 2017's static_assert(constExpr) built-in. It generates a compile-time error if constExpr evaluates to zero. The compile error is, unfortunately, not terribly informative (as it will refer to the declaration of an array with negative size).

Use this wherever a declaration is valid.

C++/C wrappers

We don't like the repeated construct:

#ifdef __cplusplus
extern "C" {
#endif

and the equivalent that's needed at the end of a C header file. We think it adds typing and is just kind of ugly. And we strive to minimize #if in code files (as opposed to header files.) So instead, we have macros:

  • MCCIADK_BEGIN_DECLS expands to the extern "C" { wrapper if compiling in C++ mode, or to nothing otherwise.

  • MCCIADK_END_DECLS expands to } if compiling in C++ mode, or to nothing otherwise.

Parameter and Variable Decoration

We like to compile with high levels of warnings, but this means we'll get errors and warnings about unreferenced parameters. Sometimes these warnings are bogus, because the parameters are part of a contract rather than being something important to the caller.

We thus have macros to tell the compiler to back off, we know what we're doing. The specific macros are:

  • MCCIADK_UNREFERENCED_PARAMETER(name) states that parameter name is intentionally not referenced by the routine.

  • MCCIADK_API_PARAMETER(name) states that parameter name is supplied as part of an API definition. The routine doesn't need it. This is subtly different than MCCIADK_UNREFERENCED_PARAMETER(); it's a stronger claim. A parameter might be unreferenced because code has evolved and we've not got around to fixing it. An API parameter is unreferenced in this particular routine, but that doesn't mean that it's not needed elsewhere.

  • MCCIADK_UNREFERENCED_VARIABLE(v) states that variable v is intentionally unreferenced (or tells the compiler that, even though it doesn't seem to be referenced, it really is). This might be used in stubs, or in code that is being tested.

mcciadk_guid.h

This header file defines useful macros for GUID manipulation. (GUIDs or UUIDs are 128-bit values that are often used in abstract API construction.)

mcciadk_baselib.h

This header file provides a number of portable APIs for use by ADK clients.

  • McciAdkLib_BufferToUlong() converts a string buffer to an unsigned long. It has well-defined error handling and overflow properties.

  • McciAdkLib_BufferToUint32() converts a string buffer to a uint32_t. It has well-defined error handling and overflow properties.

  • McciAdkLib_CharIsLower(), McciAdkLib_CharIsPrint(), McciAdkLib_CharIsUpper(), McciAdkLib_CharIsWhite(), and McciAdkLib_CharToLower() duplicate some of the functions of <ctype.h>. They're justified because they avoid Unicode and other portability distractions in embedded systems with small memory.

  • McciAdkLib_StringCompareCaseInsensitive() compares two ASCII strings without considering case, and also without internationalization considerations.

  • McciAdkLib_MultiSzIndex() is used for handling arrays of string values. Rather than using an array of char* pointers, you simply write the values into a string constant separated by "\0" values. For example, for three values, you might write:

    char my_list[] =
    "one" "\0"
    "two" "\0"
    "three" "\0"
    ;

    Then, McciAdkLib_MultiSzIndex(my_list, 0) will return a pointer to "one", McciAdkLib_MultiSzIndex(my_list, 1) will return "two", and McciAdkLib_MultiSzIndex(my_list, 2) will return "three". Other indices will return nullptr.

  • McciAdkLib_FormatDumpLine() prepares one line of a classic "memory dump" string in a buffer, with pointer, hex values, and equivalent printable values.

  • McciAdkLib_Snprintf() and McciAdkLib_Vsnprintf() are like snprintf() and vsnprintf() from <stdio.h>, but:

    1. You don't need <stdio.h> in scope to use them.
    2. They behave differently on buffer overflow. They always return the actual length of the string written to buffer, without the trailing `\0', not the length that might have been written.
    3. They allow you to easily index into the output buffer.

Targeted platforms

This library is intended for systems with 32-bit or wider architecture. It might work with AVR32 systems, but has not been tested or compiled.

MCCI uses this library regularly on ARM Cortex M0 platforms. Two of these platforms are covered by the Travis CI tests (Microchip SAMD21, and STM32L0). In addition, some users of the MCCI LoRaWAN software use ESP32, so we do CI testing with ESP32. MCCI doesn't regularly use the code on that platform, however.

Release History

  • v0.2.2 is a minor release. It has improvements for ESP32 compilation, and improves CI testing.

  • v0.2.1 is a minor release. It adds MCCIADK_VERSION and support macros, so that the Catena Arduino Platform can display the version of the libraries for system version.

  • v0.2.0 is a minor release. The only difference is in library.properties, renaming the library "MCCI Arduino Development Kit ADK" to comply with naming restrictions (issue #16). Also, we discovered a typo in the release tag itself for v0.1.4; the tag says v0.1.14. Rather than fixing this or jumping to v0.1.15, we jumped to v0.2.0.

  • v0.1.4 is a minor release. It adds McciAdkLib_SafeCopyString() (issue #8). Fixed a bug due to use of dot_a_linkage (issue #10). CI testing was extended to the MCCI STM32-based board support package (v2.0.0 or later).

  • v0.1.3 adds documentation, continuous integration with Travis CI, and fixes some compile warnings.

  • Earlier versions existed; see the Git history.

Bugs or Issues

If you find a bug you can submit an issue here on GitHub:

github.com/mcci-catena/Catena-mcciadk/issues

Before posting a new issue, please check if the same problem has been already reported by someone else to avoid duplicates.

License and Credits

MIT License

Please refer to the license file accompanying this repository.

Contributors

Terry Moore and ChaeHee Won of MCCI were the principal contributors to the code in the ADK (and the XDK on which it's based).

Trademark Acknowledgements

MCCI and MCCI Catena are registered trademarks of MCCI Corporation. All other trademarks are the properties of their respective owners.

Support Open Source Hardware

MCCI invests time and resources providing this open source code, please support MCCI and open-source hardware by purchasing products from MCCI, Adafruit and other open-source hardware/software vendors!

For information about MCCI's products, please visit store.mcci.com.