The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

v3.7 -> 4.0rc

keywords.txt: update
enums, unions, structs tags removed (useless in sarmfsw context)
arm_inlines_angle.h: avoid promotion to double for test in RAD_NORM
arm_cmsis.h: refactoring #error directives to #warning (with updated explanations)
arm_typedefs.h: force cppcheck to use explicit types for stdint
sarmfsw_version.h: SARMFSW_VERSION symbol added
Partial MISRA C2012 compliance
Moved from TravisCI to Github workflows
OVF_DIFF removal
arm_macros.h: BYTE_TO_PERC test >= 255 which doesn't raise warning when given BYTE parameter
arm_macros.h: re-enabled TEST_BITS_SET & TEST_BITS_CLR macros (TEST_BITS_VAL set to be alias of TEST_BITS_SET)
arm_keywords.h: __NEVER_INLINE symbol added
arm_keywords.h: moved keywords aliases from arm_cmsis.h to arm_keywords.h
arm_preprocess.h: definition of symbols following used C standard
arm_inlines_stdclib.h: strappend & strnappend use __NEVER_INLINE instead of __INLINE
arm_cmsis.h, arm_macros.h: UNUSED & UNUSED_RET moved to arm_macros.h
sarmfsw.h, arm_cmsis.h, arm_chip_xxx.h: arm_attributes.h included before arm_cmsis.h (some symbols needed to be moved from arm_attributes.h to arm_cmsis.h)
arm_preprocess.h: added (for pre-processing macros and directives needed to be defined at the beginning of sarmfsw)
arm_macros.h: CAT, XCAT, STR & XSTR moved to arm_preprocess.h
sarmfsw.h: arm_preprocess.h added & arm_macros.h moved
arm_typedefs.h: uintPTR_t & intPTR_t added
arm_inlines_stdclib.h: renamed to arm_inlines_stdclib, total refactoring and inlines added
arm_attributes.h: PRINTF__ & FMT__ attributes added (+ some compilers attributes review)
I_FIND_BINARY_HEADER_USEFUL symbol renamed to USE_INO_BINARY_HEADER
arm_typedefs.h & arm_chip_ino: fix for USE_INO_BINARY_HEADER (re-define B0 & B1)
arm_errors.h: error codes added
arm_chip_stm32.h: STM32_UNIQUE_ID split to get 3 different parts of unique ID
arm_inlines_float.h: get_fp_dec fix for negative values
arm_cmsis.h: update for STM32 families (also added H7RS, MP2, MP13, N6, WB0 families)
arm_macros.h: isNull & isNotNull added
arm_macros.h: isOdd & isEven added
arm_macros.h: SET_BITS_VAL also applies mask on given value to apply
arm_inlines_ascii.h: strHexToInt fix for 8b/16b platforms
arm_inlines_var_test.h: inTolerance fix for negative reference values
arm_cmsis.h: SARMFSW_NO_CHIP_HAL symbol implementation
arm_cmsis.h & arm_chip_xxx.h: HALTicks symbol refactoring and checks added for provided function declaration consistency
arm_macros.h: TEST_BITS_VAL & TEST_MASK_VAL macros added
arm_macros.h: Register intended macros (such as GET_BITS...) encloses tested variable/register/values in parentheses
arm_macros.h: OVF_DIFF fix, thanks to @Simben
arm_inlines_float.h: SPLIT_FLOAT_TO_INTS added
arm_inlines_float.h: sIntFrac struct and associated float2sIntFrac and sIntFrac2float functions added
arm_cmsis.h: Some CMSIS alias macros added
arm_macros.h: XSTR added (stringification of an expanded macro)
arm_inlines_stdclib.h: str_add_cr change (adding only cr) + str_add_lf and str_add_crlf added
arm_macros.h: OVF_DIFF added (overflow handling diff)
arm_inlines_ticks.h: inlines use of OVF_DIFF
arm_macros.h: min, max, min3, max3 & clamp refactored (double evaluation safe)
arm_macros.h: min & max declared as upper case, preventing std::min std::max issues when the library is included in cpp file
min and max uses set to upper case in the whole library (cpp std workaround)
arm_attributes.h: TYPEOF__ alias added, ASM__ alias set to __asm__ for consistency
sarmfsw.h: include order set back (to keep compatibility without warnings with older cmsis versions)
arm_chip_xxx.h: all qualifier macros for functions changed by explicit qualifiers (due to includes order)
sarmfsw.h: include order fix (so that arm_chip_xxx attributes can be properly pre-processed) -> revert
arm_hal_peripheral.h: pre-processing symbols can be defined to disable HAL includes (globally or separately)

v3.6

arm_cmsis.h: update for STM32 families (also added H5, WBA families)
sarmfsw.h: includes order fix
arm_attributes.h: __STATIC keyword added
arm_attributes.h: __INLINE keyword workaround with C99 inline semantics (static inlining)
library entry point being sarmfsw.h, most cross includes in files now removed
inlines variable length and types reviewed
arm_inlines_average.h: code size optimization
arm_hal_peripheral.h: PCD device enabled includes usb_device.h header
arm_macros.h: SCALE_VAL_T added
arm_macros.h: BYTE_TO_PERC byte value clamp added
arm_macros.h: LSHIFT & RSHIFT changed (handling optimized shift opcodes and more explicit sizes if desired/required)
arm_typedefs.h: intCPU_t & uintCPU_t typedefs added
arm_hal_peripheral.h: No include for some peripherals without dedicated headers (STM32)
arm_chip_xxx.h: an external definition of HAL_getTick is provided when used (implicitly checking consistency with the one defined in the project)
arm_attributes.h: few fixes and CSMC compiler attributes added
arm_cmsis.h: volatile symbols definitions added in case not defined
arm_cmsis.h: UNUSED symbol definition (removed multiple definitions from other files)
arm_cmsis.h: __ASM symbol definition moved to arm_attributes.h.h
arm_cmsis.h: xc symbol test fix; moved __INLINE and __STATIC_INLINE definitions (when defined) in arm_attributes.h.h
arm_attributes.h: manual definition of __INLINE and __STATIC_INLINE if __STATIC_FORCEINLINE is not defined
arm_attributes.h: xc symbol test fix; moved xc part prior to gnuc (as the symbol is also defined by xc compiler)
README.md & keywords.txt update
arm_cmsis.h: update for STM32 families (also added C0, U5 families)
introducing Microchip XC compiler & PIC compatibility
arm_typedefs.h: stdbool.h & stdint.h can be skipped if not handled by compiler (through pre-processing symbols definition)
arm_typedefs.h: matching stdbool.h & stdint.h common types used in arm_typdefs.h to native C types by typedefs if headers are not included
arm_inlines_ascii.h: strDecToInt & strHexToInt returns correctly converted part if something goes wrong
arm_inlines_ascii.h: added check and convert inlines (num, alphanum, lower and upper case)
arm_inlines_ascii.h: added strDecToInt & strHexToInt
arm_inlines_linearization.h: sLinearFlexArray typedef & linearization_eval_flex function added
arm_inlines_linearization.h: linearization_eval constant parameters, nb values set to 32b
arm_inlines_linearization.h: linearXXX LINEAR_TAB macro generated name now outputs sLinearXXX
arm_attributes.h: scalar storage order attributes defined for __GNUC__ compiler (mostly for reference, not defined for other compilers)
Doxyfiles updated to reflect changes in Doxygen v1.9.x

v3.5

arm_inlines_ascii.h: fix lower case result of ASCIIToHex
arm_inlines_var_size.h: fix reducing number of bits in convXtoYBits
arm_inlines_float.h: limit set to 9 digits after floating point in get_fp_dec
arm_attributes.h: Overriding inline attributes when optimizations are set to none with gcc like toolchains
Doxyfiles updated to reflect changes in Doxygen v1.9.x

v3.4

Some refactoring
arm_chip_stm32.h: few changes using G0 family
arm_chip_stm32.h: Added other reset sources in eResetSource
arm_chip_stm32.h: pins & ports refactored to stm_xxx
arm_cmsis.h: update for STM32 families (also added G4, L5, MP1 & WB families)
arm_macros.h: SZ_ARRAY macro added
arm_macros.h: charNUL renamed to charNULL
arm_macros.h: mathematical constants under the macro form M_xxx as in math.h
arm_macros.h: added bitwise boolean arithmetic macros (useful for registers or bitfields registers/variables)
arm_macros.h: added SCALE_VAL macro
arm_inlines.h: inlines split into separate files
arm_inlines_angle.h: added inlines instead of associated macros in arm_macros.h.h (and associated constants)
arm_inlines_angle.h: DEG_TO_RAD & RAD_TO_DEG not defined for Arduino platforms (already defined as conversion value)
arm_inlines_bcd.h: updated inlines to handle up to 32b conversions
arm_inlines_rotation.h: added 2D coordinates rotation inline
arm_inlines_linearization.h: added linearization inline
arm_inlines_ascii.h: fix HexToASCII
arm_inlines_float.h: changed get_fp_dec to get decimal part as absolute value
arm_inlines_var_size.h: added mask on input value in convXtoYBits (if value given size mismatch with from size)
arm_inlines_var_size.h: replaced sums by bitwise or operations in every variable size expansion inlines
arm_inlines_var_size.h: added scaleValue macro
arm_inlines_stdclib.h: fix str_clr_safe use of sarmfsw macros and use of predefined macros
arm_typedefs.h: BIG_ENDIAN/LITTLE_ENDIAN/PDP_ENDIAN changed to ___XXX_ENDIAN___ (were already all defined in endian.h)

v3.3

Doxyfile update
Adding support for unit tests and doxygen documentation generation with Travis CI
A few type names changed to their own typedefs
arm_attributes.h: Added macro for section, used, nonnull(...) & ATTR__ multiple attributes
arm_cmsis.h: Added latest STM32 chips (and STM32G0 family added)
arm_chip_stm32.h: Added FLASH_SIZE macro (returning flash size in bytes)
arm_chip_stm32.h: Added enum for last reset source (TODO: add more for sam & ino)
arm_chip_stm32.h: Added some special STM32 registers getter macros
arm_hal_peripheral.h: Removed unlikely defined include files (not related to STM32 peripherals, rather linked to middlewares)
arm_hal_peripheral.h: Fixed qspi.h include (quadspi.h)
arm_inlines.h: added some binary manipulation inlines
arm_inlines.h: added nonnull check for pointers in SWAP_ENDxxB_TAB
arm_inlines.h: added temperature conversions (kelvin, celsius, fahrenheit)
arm_inlines.h: added RestrictedAverage_XXX inlines
arm_inlines.h: ASCIIToHex returns BYTE with 0xFF value if not valid ASCII char
arm_inlines.h: var size conversions (bits) fixed to gain accuracy
arm_inlines.h: inline added to convert var size from x to y number of bits
arm_macros.h & arm_inlines_stdclib.h: simplified STR macro (no need of "")
arm_macros.h: moved TestMalloc to arm_macros.h.h (renamed to malloc_assert)
arm_macros.h: added SZ_TYP_MBR macro to get the sizeof of a member in a structure
arm_macros.h: added TYP_MBR macro to get member of typedef struct
arm_macros.h: added TYP_MBR_TYP macro to get type of member in typedef struct
arm_macros.h: added VAL_AT macro to get the content of an address
arm_macros.h: added undef of LOBYTE & HIBYTE if previously defined
arm_typedefs.h: Doxygen eGPIOState enum name fixed
arm_typedefs.h: Doxygen note added related to Arduino platform (for binary representation in binary.h)
sarmfsw.h: target names changed in enum
keywords.txt: added Error codes & Reset codes
misc: typo fixes, Doxygen comments, notes & warnings added
README.md: sections added

v3.2

arm_typedefs.h: endianness handling for bitfields and unions
arm_typedefs.h: added eGPIOState & eGPIOPull enums
arm_inlines.h: added L & LL qualifiers when needed for compatibility with <32b architectures
arm_inlines.h: added testEndian basic & full inlines
arm_macros.h: added SWAP_TYPE macro for any simple typedef swapping
arm_macros.h: added missing SWAP_LWORD, SWAP_FLOAT & SWAP_DOUBLE macros
arm_macros.h: added aliases for True, False, TRUE, FALSE
README.md: added list and description of special symbols to change library behavior
keywords.txt: Added new and enum literal keywords

v3.1

arm_chip_ino.h: fixed enable/disable interrupts macro (and undef arm_cmsis.h defined ones)
arm_chip_ino.h: fixed Arduino HALTicks macro (ms tick base is millis, not micros)

v3.0

moved defines & inlines from arm_hal_peripheral.h to arm_family headers
arm_macros.h: added ROOT_OF macro
arm_macros.h: added L qualifier for LSHIFT & RSHIFT (compatibility with less than 32b CPUs)
arm_inlines.h: const qualifier for most inline parameters
arm_inlines.h: modified TPSSUP_MS & TPSINF_MS to handle custom tick frequency (following arm_family header or custom defines)
arm_chip_sam.h: refactored doxygen comments block
arm_cmsis.h: fixed multi-line macro SAMDA1
arm_chip_ino.h: made compatible with Arduino platform

v2.0

arm_macros.h: added shifting macros & refactoring
arm_inlines.h: refactoring & added some inlines for 64b and bcd, ascii & gray code
arm_inlines.h: removed some always inline qualifiers for some inlines producing lots of instructions
arm_inlines.h: inTolerance tolerance param is now float for higher accuracy when needed
arm_inlines.h: using an alias defined in arm_hal_peripheral.h.h for GetTicks call
arm_inlines.h: added get_fp_dec (formerly in HARMcksL)
arm_cmsis.h: updated latest chips references for STMicro
arm_cmsis.h: platform CMSIS includes & HAL config included from there
arm_cmsis.h: removed including HAL config (already included from CMSIS includes)
arm_hal_peripheral.h: added to include used peripherals
arm_hal_peripheral.h: reworked all peripheral includes
arm_chip_stm32.h: added wrapper for PWM tim/channels
arm_chip_stm32.h: refactored wrappers for TIM & GPIO names to what's mentioned here
arm_chip_sam.h: added support for Atmel SAM families
arm_chip_xxx.h: Families divided into files with respective family name
arm_errors.h: added to sarmfsw & refactored ERR_xx to ERROR_xx
arm_attributes.h: renamed WEAK__ to __WEAK
arm_attributes.h: added various compiler attributes definition
added missing includes in some headers (to be able to import them as standalone)
refactored includes order and where some declarations are done through files
refactored names of platform header files
added anchors to define external C (for Cpp)

v1.0

arm_cmsis.h: added generic define for all families
STM_CONF_HEADER() includes hal header file instead of hal conf directly (more HAL access)
Added macro SZ_OBJ to compute the number of elements of an object following its type
arm_cmsis.h: added macros to enable/disable interrupts
arm_macros.h: Renamed macro OFFSETOF, now OFFSET_OF & removed space after & in OFFSET_OF macro (causing issues compiling with gcc)
arm_macros.h: Some refactoring and bool returning inlines optimization
sarmfsw.h: includes CMSIS & HAL header files by default
arm_inlines.h: Added file for inlines, as some needs to access to HAL (included after arm_cmsis.h)
arm_inlines.h: inRange & inTolerance now using int32_t

v0.9 and below

initial commit and beta versions