diff --git a/html/_r_e_a_d_m_e_8md.html b/html/_r_e_a_d_m_e_8md.html new file mode 100644 index 0000000..f54fb72 --- /dev/null +++ b/html/_r_e_a_d_m_e_8md.html @@ -0,0 +1,84 @@ + + +
+ + + + +
+ sarmfsw: SMFSW Toolbox (for ARM & compatible with Arduino platform) 3.7
+
+ SMFSW collection of miscellaneous functions & macros (for ARM & compatible with Arduino platform)
+ |
+
+ sarmfsw: SMFSW Toolbox (for ARM & compatible with Arduino platform) 3.7
+
+ SMFSW collection of miscellaneous functions & macros (for ARM & compatible with Arduino platform)
+ |
+
Basic yet useful typedefs/macros/inlines for any ARM CMSIS based project
+Library has been updated to become compatible with Arduino & other 8/16bit platforms (not only ARM cores, yet less optimized for 8/16bit cores)
+STM_FAMILY
: Define with proper family name if your STM32 MCU is not automatically recognized (in case of warning message displayed)SAM_FAMILY
: Define with proper family name if your ATMEL SAM MCU is not automatically recognized (in case of warning message displayed)SARMFSW_NO_CHIP_HAL
: No includes and definitions of HAL chip files (can be useful to use sarmfsw for static libraries code generation)HALTicks
: can be defined with a function name to use ticks getter function already implemented under the form uint32_t func(void)
HAL_MAX_TICKS
val: Define with custom max value in project if tick max value is not using 32b variable full scaleHAL_MS_TICKS_FACTOR
: Define with custom multiplier in project if tick period is not 1msHAL_INC_DISABLE
: Define this symbol at project level to disable inclusion of all HAL headersHAL_XXX_INC_DISABLE
: Define this symbol at project level (replacing XXX
by peripheral name) to disable inclusion of corresponding HAL headerBIG_ENDIAN
: Define this symbol when using big endian target architecture if not automatically recognized (in case of warning message displayed)LITTLE_ENDIAN
: Define this symbol when using little endian target architecture if not automatically recognized (in case of warning message displayed)REVERSE_BITFIELD
: By default bitfields are stored from lsb to msb; if not the case with used compiler, use a pragma or define this symbolSTDBOOL_NDEF
: define this symbol in case used compiler doesn't have stdbool.h headerSTDINT_NDEF
: define this symbol in case used compiler doesn't have stdint.h headerI_FIND_BINARY_HEADER_USEFUL
: For Arduino platform, if using defines from binary.h, define this symbol (not recommended, use 0bxxx for binary instead)SINGLE_SHIFT_ONLY_OPCODE
: If used CPU only handles single shifts opcode, define this symbol to optimize use of LSHIFTx & RSHIFTx with constantsNO_STATIC_FUNC
or UNITY_TESTING
: using __STATIC keyword, functions will always be visible by linker if set (useful for unit testing)Macros/Inlines name standardization (case) not always respected for backward compatibility with older versions:
Doxygen doc can be generated using "Doxyfile"
+ +See release notes
+
+ sarmfsw: SMFSW Toolbox (for ARM & compatible with Arduino platform) 3.7
+
+ SMFSW collection of miscellaneous functions & macros (for ARM & compatible with Arduino platform)
+ |
+
The MIT License (MIT)
+Copyright (c) 2017-2024 SMFSW (Sebastien Bizien)
+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.
+