Add basic CMSIS core headers #384

kilograham · 2021-05-05T20:26:44Z

Adds a new cmsis_core INTERFACE library, which provides the basic CMSIS macros/definitions, and RP2040.h and system_RP2040.h
By default the isr_ methods in the vector table are renamed to their CMSIS versions, but this can be overridden by defining PICO_CMSIS_RENAME_EXCEPTIONS=0

fixes #21

kilograham · 2021-05-05T20:27:25Z

This depends on #382 for the exception/irq handler renaming

Adds a new cmsis_core INTERFACE library, which provides the basic CMSIS macros/definitions, and RP2040.h and system_RP2040.h By default the isr_ methods in the vector table are renamed to their CMSIS versions, but this can be overridden by defining PICO_CMSIS_RENAME_EXCEPTIONS=0

lurch · 2021-05-11T16:24:49Z

src/rp2_common/cmsis/CMakeLists.txt

+# at least if the vendor/device is RaspberryPi/RP2040...
+
+## PICO_CMAKE_CONFIG: PICO_CMSIS_PATH, directory to locate CMSIS installation, default="included stub CORE only impl", group=build
+#if (DEFINED PICO_CMSIS_PATH)


It doesn't really matter, because this is all commented-out anyway, but should the PICO_CMSIS_PATH variables you've used here actually be PICO_CMSIS_CORE_PATH so that it matches up with the non-commented-out code below?

src/rp2_common/cmsis/include/cmsis/rename_exceptions.h

lurch · 2021-05-11T16:31:07Z

src/rp2_common/cmsis/stub/CMSIS/Core/Include/cmsis_compiler.h

+/*
+ * Copyright (c) 2009-2018 Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: Apache-2.0


If we're including Apache-licensed code into the SDK, do we need to mention something about this in our README.md ? 🤷 🤷

lurch · 2021-05-11T16:33:58Z

src/rp2_common/cmsis/stub/CMSIS/Core/Include/mpu_armv7.h

@@ -0,0 +1,275 @@
+/******************************************************************************
+ * @file     mpu_armv7.h
+ * @brief    CMSIS MPU API for Armv7-M MPU


We probably don't need an Armv7-M header? 😉 Or does the CMSIS stuff fail to compile without it?

it is a badly named file

lurch · 2021-05-11T16:37:13Z

src/rp2_common/cmsis/stub/CMSIS/Device/RaspberryPi/RP2040/Include/RP2040.h

+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause


This file has both:

SPDX-License-Identifier: Apache-2.0 SPDX-License-Identifier: BSD-3-Clause

Does that mean it's dual-licensed, and the user can pick which licence they use it under? If that is the case, perhaps it's worth adding a quick comment explaining that?

lurch · 2021-05-11T16:41:29Z

FYI I didn't review this previously, because it was marked as a Draft PR.

kilograham · 2021-05-11T18:36:25Z

FYI I didn't review this previously, because it was marked as a Draft PR.

ah, makes sense!

lurch · 2021-05-11T23:38:56Z

ping @ghollingworth for queries about the mixed-licensing.

liamfraser

LGTM

See release notes for more descriptive details * Delete some redundant CMake parts (#240) * pio: Add 'pragma once' to generated header files (#237) * pio: allow programs with 32 instructions (#236) * Fixup incorrect doxygen for multicore_fifo_wready * Add param-validation to spin_lock_instance * Fix back-to-front description of IRQ priority in doxygen (#245) * Fix ROSC typo (#259) * Typo (#251) * Add gpio_get_out_level() accessor, and correct SIO GPIO_OUT struct ty… (#247) * Add gpio_get_out_level() accessor, and correct SIO GPIO_OUT struct type from WO to RW * Add pico_get_unique_board_id_string API (#281) * Clean up -Wconversion=error issues * move PLL reset code from clocks driver to pll driver (#110) * Don't clear PLL PWR/FBDIV after reset as unnecessary. Call out in runtime.c why USB/syscfg aren't reset. * i2c: set hold time of SDA during transmit to an appropriate value (#273) * i2c: set hold time of SDA during transmit to 2 for TCS34725 color sensor * i2c: fix issues in i2c_write_blocking_internal * i2c: rename sda_hold_count to sda_tx_hold_count * use assert rather than invalid_params_if for internal consistency checks * i2c: use a more appropriate sda tx hold time at higher baudrates * i2c: reduce 120/1e9 to the smallest possible integer numerator and denominator * Update NULL GPIO function to 0x1f (#320) * i2c: set high and low times to values that conform to the i2c specification (#314) * Make flash_do_cmd public (#269) * Fix implementation config listing in structs/i2c.h (#324) * Clarify that cache is flushed, but that function is intended for low-level metadata access during startup (#322) * Fix implementation config listing in structs/i2c.h (#325) * Fix param-validation for PIO sideset encoding (#311) * Remove MASTER_ON_HOLD bit from I2C status registers. Fix typos. (#326) * Fixing arithmetic underflow in SPI I/O loops #337 (#338) * Source code licence clarification (#340) * Updated existing Pimoroni board headers to match latest style, and added a new board (#343) * Added new pimoroni board headers * SPI Definitions for SparkFun boards (#344) * SPI Definitions for SparkFun boards * Clarify multicore_fifo doxygen (#323) Based on my observations in #284 * correct adafruit flash size for itsybitsy and qt rp2040 (#348) from 4 MB to 8 MB * Small typos (#366) * make spi_init return baud rate set (#296) * Fix path + typo in README.md (#347) * Fix path + typo in README.md * Remove incorrect path change * Remove typo * disable core 0 SIO FIFO IRQ handler during core 1 launch in case someone has already installed one (#375) * add PICO_DIVIDER_DISABLE_INTERRUPTS flag which makes PICO_DIVIDER disable interrupts around division rather than using co-operative guards to protect nested use (i.e. within IRQ/exception). Use of this flag can simplify porting of RTOSes but with a different performance profile (#372) * make all non hardware_ libraries foo add C preprocessor definition LIB_FOO=1, and remove bespoke definitions which were all undocumented anyway (#374) * Change various (confusing to user) message to be DEBUG only (#365) * add small delay to stdio_get_until to prevent starvation of USB IRQ handler due to in use mutex. build was non deterministic due to missing link wrapping of getchar (#364) * Some cmake build improvements (#376) * Change some cmake output to DEBUG level Make SDK build more consistent with other libraries (use an INTERFACE marker library for inclusion tests) Add PICO_SDK_PRE_LIST_FILES, PICO_SDK_POST_LIST_FILES build vars * fix typo * remove leftover debugging message * i2c: improve communication with i2c devices in i2c_write_blocking * Definitions for IC_TX_BUFFER_DEPTH inconsistent (fixes #335) (#381) * Add hardware_exception for setting exception handlers at runtime (#380) * add __always_inline to trivial super low level inline functions (#379) * Rework lock_core / timers (#378) * remove spurious sys/select.h include (#377) * Fixup IRQ_PRIORITY #define values (#393) * Correct doxygen for mutex_try_enter (#392) * Fix a bunch of doxygen typos (#391) * Rework ordering of cmake, so that libraries in subdirectories can add to internal lists as PICO_SDK_POST_LIST_FILES, PICO_CONFIG_HEADER_FILES etc. (#382) * Fix some hardware_library dependencies (#383) * make host pico_platform.h and binary_info.h CMakeLists.txt safe for inclusion in non SDK build (#388) * Add basic CMSIS core headers (#384) * Fix the PICO_CONFIG default value for PICO_CMSIS_RENAME_EXCEPTIONS (#399) * add timeout_us/until to mutex/sem blocking methods (#402) * Fixup divider save_restore for floating point too; improve tests (#405) * fix pico_promote_common_scope_vars (#397) * add comment about using clk_gpout0 enable bit (Fixes #413) * pioasm: prevent double inclusion for C SDK generated headers (#417) * Add missing cast to uint32_t in hw_divider_u32_quotient for host (#436) * Optional feature to get the max level that has ever been held by a queue (#444) * Fix wrong format string in alarm_pool_dump_key (#437) * Add support for Arduino Nano RP2040 Connect (#425) * Add support for Arduino Nano RP2040 Connect * Add support for at25sf128a flash * Fix function-name misspelling (#443) * Update host multicore.h to match multicore.h in rp2_common (#439) * Implement `uart_write_blocking` and `uart_read_blocking` for host (#438) * Define `__STRING` for other compilers than MSVC in the host platform.h file (#434) * Prevent warnings about some unused parameters in pico_stdio_usb when building with -Wextra (#431) * Fix warnings about some unused parameters in pico_stdio_usb * Use `__unused` for the unused parameter in tud_descriptor_configuration_cb * Remove redundant inclusions of `pico/platform.h` * Define `void operator delete[](void *p, std::size_t n)` in new_delete.cpp (#430) * queue: make data pointers const in queue_try_add and queue_add_blocking (#423) * misc interp_ fixes (#428) * some typo fixes (#408) * Prevent the literal string DEBUG from being appended to some messages in CMake < 3.15 (#433) * Add function to get the currently selected channel (#451) * Add missing board detection macros (#448) * add board detection macros for Sparkfun & RPi Pico / VGA Board * dma_channel_transfer_[from/to]_buffer_now: added const volatile to read_addr and volatile to write_addr (#449) * Change the quick-start instructions to include installation of the (#92) * added spi_get_baudrate() + some consistency changes (#395) * Allow lengthening xosc startup delay with a compile option (#457) * Add hardware_gpio accessors for Schmitt, slew rate, drive strength (fixes #290) (#464) * Add some spin lock related doxygen * Move to Tinyusb 0.10.0 (#462) * Add usb device dpram to svd file. Fixes #351 (#465) * Add PICO_PANIC_FUNCTION define to allow replacement of the default panic function (#463) * Add missing DREQ_ definitions * store actual clock frequency in clock_configure (fixes #368) * Fix hw_is_claimed, and add xxx_is_claimed APIs * Add some PIO irq helper methods * Add DMA channel IRQ status getter and clear methods * Implement the correct PIO IRQ status/clear methods (good to have methods here as the h/w interrupt registers are super confusing) * fix pico_multicore dependencies * add missing wrapper func __aeabi_f2d * Further DMA/PIO IRQ API cleanup (and review fixes) * add PICO_INT64_OPS_IN_RAM flag * fix qtpy rp2040 uart rx rev B (#466) * Move to tinyusb 0.10.1 (upstream tinyusb repo) ($467) * Add gpio_set_irqover to match inover/outover/oeover (fixes #265) (#470) Co-authored-by: Andrew Scheller <andrew.scheller@raspberrypi.com> Co-authored-by: Christian Flach <cmfcmf.flach@gmail.com> Co-authored-by: Luke Wren <wren6991@gmail.com> Co-authored-by: Earle F. Philhower, III <earlephilhower@yahoo.com> Co-authored-by: majbthrd <majbthrd@gmail.com> Co-authored-by: Peter Lawrence <12226419+majbthrd@users.noreply.github.com> Co-authored-by: Brian Cooke <bdscooke@gmail.com> Co-authored-by: Scott Shawcroft <scott@tannewt.org> Co-authored-by: Michael Stoops <spam@michaelstoops.com> Co-authored-by: ZodiusInfuser <christopher.parrott2@gmail.com> Co-authored-by: Kirk Benell <36707344+kirk-sfe@users.noreply.github.com> Co-authored-by: Ha Thach <thach@tinyusb.org> Co-authored-by: Exr0n <spotyie@gmail.com> Co-authored-by: Joni Kähärä <joni.kahara@async.fi> Co-authored-by: Rafael G. Martins <rafael@rafaelmartins.eng.br> Co-authored-by: Jonathan Reichelt Gjertsen <jonath.re@gmail.com> Co-authored-by: Martino Facchin <m.facchin@arduino.cc> Co-authored-by: Rene <reneg973@gmail.com> Co-authored-by: Brendan <2bndy5@gmail.com> Co-authored-by: geurtv <48989893+geurtv@users.noreply.github.com> Co-authored-by: ewpa <34030942+ewpa@users.noreply.github.com> Co-authored-by: Dan Halbert <halbert@halwitz.org> Co-authored-by: Liam Fraser <liam@raspberrypi.com>

ghollingworth · 2021-06-07T06:04:44Z

Graham,

We should add the CMSIS license to this LICENSE file and just list the path of files that are covered by it.

Gordon

kilograham · 2021-06-07T14:22:25Z

@ghollingworth you are a day late and a dollar short. this is already merged/released. Also

We should add the CMSIS license to this LICENSE file and just list the path of files that are covered by it.

What is this license? list the files where?

might be simplest to submit a PR.

lurch · 2021-06-07T14:29:26Z

I suspect Gordon might have been thinking something along the lines of https://github.com/raspberrypi/firmware/blob/master/README.md ? 🤷

EDIT: Or https://github.com/raspberrypi/rpi-eeprom/blob/master/LICENSE ? 🤷

ghollingworth · 2021-06-08T06:11:35Z

No I was thinking along the lines of the debian copyright format:

https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

This allows something like the following:

Files: *
Copyright: 1975-2010 Ulla Upstream
License: GPL-2+

Files: debian/*
Copyright: 2010 Daniela Debianizer
License: GPL-2+

Files: debian/patches/fancy-feature
Copyright: 2010 Daniela Debianizer
License: GPL-3+

Files: */*.1
Copyright: 2010 Manuela Manpager
License: GPL-2+

kilograham added this to the 1.2.0 milestone May 5, 2021

kilograham self-assigned this May 5, 2021

kilograham marked this pull request as draft May 5, 2021 20:26

kilograham force-pushed the cmsis branch 2 times, most recently from 8b7f311 to aabc4d1 Compare May 6, 2021 17:18

kilograham mentioned this pull request May 6, 2021

Add CMSIS-Core headers #21

Closed

kilograham marked this pull request as ready for review May 10, 2021 13:52

kilograham force-pushed the cmsis branch from aabc4d1 to f79e23c Compare May 11, 2021 15:40

kilograham linked an issue May 11, 2021 that may be closed by this pull request

Add CMSIS-Core headers #21

Closed

kilograham merged commit b05d863 into develop May 11, 2021

kilograham deleted the cmsis branch May 11, 2021 15:47

lurch reviewed May 11, 2021

View reviewed changes

src/rp2_common/cmsis/include/cmsis/rename_exceptions.h Show resolved Hide resolved

lurch reviewed May 11, 2021

View reviewed changes

liamfraser reviewed May 18, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add basic CMSIS core headers #384

Add basic CMSIS core headers #384

kilograham commented May 5, 2021

kilograham commented May 5, 2021

lurch May 11, 2021

lurch May 11, 2021

lurch May 11, 2021

kilograham May 11, 2021

lurch May 11, 2021

lurch commented May 11, 2021

kilograham commented May 11, 2021

lurch commented May 11, 2021

liamfraser left a comment

ghollingworth commented Jun 7, 2021

kilograham commented Jun 7, 2021 •

edited

lurch commented Jun 7, 2021 •

edited

ghollingworth commented Jun 8, 2021

Add basic CMSIS core headers #384

Add basic CMSIS core headers #384

Conversation

kilograham commented May 5, 2021

kilograham commented May 5, 2021

lurch May 11, 2021

Choose a reason for hiding this comment

lurch May 11, 2021

Choose a reason for hiding this comment

lurch May 11, 2021

Choose a reason for hiding this comment

kilograham May 11, 2021

Choose a reason for hiding this comment

lurch May 11, 2021

Choose a reason for hiding this comment

lurch commented May 11, 2021

kilograham commented May 11, 2021

lurch commented May 11, 2021

liamfraser left a comment

Choose a reason for hiding this comment

ghollingworth commented Jun 7, 2021

kilograham commented Jun 7, 2021 • edited

lurch commented Jun 7, 2021 • edited

ghollingworth commented Jun 8, 2021

kilograham commented Jun 7, 2021 •

edited

lurch commented Jun 7, 2021 •

edited