Puya PY32F MCU support - #5106
Conversation
|
Hello @burgrp thank you for working on this. Have you seen this page? I think you will find it helpful. 😸 |
|
@burgrp I have switched the branch for this PR to Can you please rebase it against the latest Planning on ordering a few of these myself, thanks for working on it! |
|
@burgrp You are updating |
|
You are right... I will fix it and hopefully it will be possible to merge the PR. |
|
@b0ch3nski , the sub-module issue is fixed, all checks are passing |
|
Thanks! I think now there is some unrelated change also in |
|
@b0ch3nski looks that way to me as well: https://github.com/tinygo-org/tinygo/pull/5106/changes#diff-d7ea94295bc068e99e5edeacb50734849fb40d5aa39cbc68be5e55c0d90bd60a @burgrp one other thing that is needed is to add something to the smoketests to show that at least everything can build. Someplace appropriate in here, please: https://github.com/tinygo-org/tinygo/blob/dev/GNUmakefile#L567-L989 |
|
@b0ch3nski , @deadprogram smoketests added, net module update reverted |
| return uint8(p) & 0x0F | ||
| } | ||
|
|
||
| func (p Pin) getPort() (*py32.GPIO_Type, uint8) { |
There was a problem hiding this comment.
Better to use unsafe.Add() if you must. Probably even better to use a switch to avoid possible errors.
| switch config.Mode { | ||
|
|
||
| case PinInputFloating: | ||
| port.MODER.ReplaceBits(gpioModeInput, gpioModeMask, pos) |
There was a problem hiding this comment.
I have not installed/run the gen-device-py32 yet, but I assume there are probably some functions like SetMODERInput() that are being generated. Using these are usually preferable, to avoid possible bugs from setting unexpected bits.
There was a problem hiding this comment.
Unfortunately there is no SetMODERInput() generated. These helper functions are generated in form SetMODER_MODE0()...SetMODER_MODE15(), which are quite useless for parametric access.
I've fixed the machine constants to use the svd pin0 generated constants e.g.:
gpioModeOutput = py32.GPIO_MODER_MODE0_Output
so there is at least some binding to svd values.
| const PinInput PinMode = PinInputFloating | ||
|
|
||
| const ( | ||
| gpioModeInput = 0 |
There was a problem hiding this comment.
Are any of these being generated from the SVD file already? See comment below.
| // peripheral clock frequency. | ||
| func InitSerialWithClock(clockHz uint32) { | ||
| py32UARTClockHz = clockHz | ||
| //Serial.ConfigureWithClock(UARTConfig{}, clockHz) |
| py32.RCC.SetICSCR_HSI_FS(py32.RCC_ICSCR_HSI_FS_Freq24MHz) | ||
|
|
||
| ConfigureSystemTimer(24_000_000) | ||
| machine.InitSerial() |
There was a problem hiding this comment.
This perhaps needs to be moved into an init() function?
See #5200 (comment)
| ], | ||
| "build-tags": [ | ||
| "embedfire_py32f002b", | ||
| "default_uart_pins" |
|
I've taken a look and have some reservations on exported API chosen. I'd like to better understand how we define APIs in machine package to understand if the exported functions implemented here match with what the rest of TinyGo does. Basically working on getting something like |
|
I vibe coded a tool to help us understand the tinygo APIs better. I'll invite you all to check it out to understand what our APIs look like in TinyGo #5224 |
soypat
left a comment
There was a problem hiding this comment.
Running tgdoc I've found what look like discrepancies with usual TinyGo API.
You can browse our APIs by running go run ./cmd/tgdoc -http=:18080 ../tinygo/targets ../tinygo/src/machine given tinygodoc shares tinygo parent directory
https://github.com/tinygo-org/tinygodoc
|
|
||
| // ConfigureWithClock initializes the UART using the provided peripheral clock | ||
| // frequency (in Hz). This avoids assuming a fixed MCU clock. | ||
| func (uart *UART) ConfigureWithClock(config UARTConfig, clockHz uint32) error { |
There was a problem hiding this comment.
can we replace clockHz with CPUFrequency() internal call to Configure?
|
|
||
| // InitSerialWithClock configures the default Serial using the supplied | ||
| // peripheral clock frequency. | ||
| func InitSerialWithClock(clockHz uint32) { |
| } | ||
|
|
||
| // Configure pin for use by UART | ||
| func ConfigureUARTPin(pin Pin, af uint8) { |
There was a problem hiding this comment.
Shouldn't this be Pin.Configure followed by an SetAltFunc? (is it really necessary to export this?)
There was a problem hiding this comment.
Or unexport it if it is expected to only be called internally for UART configuration
There was a problem hiding this comment.
You are right, cleaned up to just Pin.Configure+SetAltFunc.
This needs to be exported, because other boards may need explicit call for non-default UART pins.
There was a problem hiding this comment.
Non default pins can be configured with the UARTConfig struct. Please unexport this.
There was a problem hiding this comment.
Unfortunately it can't be configured using UARTConfig on PY32F. We need to pass the AF parameter somehow.
There was a problem hiding this comment.
However, I will try to fix it somehow...
| func SetCPUFrequency(frequency uint32) { | ||
| CPUFrequencyHz = frequency | ||
| } |
There was a problem hiding this comment.
This is a very confusing API- it does not actually change the frequency. Prefer unexporting it and either linking with //go:linkname compiler directive from runtime package or setting as constant at build time.
There was a problem hiding this comment.
I agree - the function is removed. The variable CPUFrequencyHz still needs to be exported to allow clock change from user code.
There was a problem hiding this comment.
Why do you want to allow changing CPU frequency from user code?
There was a problem hiding this comment.
This API does not exist yet in TinyGo, we'd likely need to discuss the best design going forward if we are to add it
There was a problem hiding this comment.
For two simple reasons (correct me if I'm not seeing something):
- TinyGo comes with a finite set of supported dev boards. In practice, final product boards differ, so they may need other setting.
- There may be application which need to set clock dynamically, e.g. to save energy.
There was a problem hiding this comment.
There was a problem hiding this comment.
Yes, I need that for one of my projects. Thanks for being open to discuss it!
There was a problem hiding this comment.
I'd hate for this to stay in a stale state while we discuss the CPUFrequency API. Could you implement CPU frequency API on your side and test things and let us know how your experimentation goes?
There was a problem hiding this comment.
This API is still very unintuitive because it does exactly none of what it says it does. Calling this function does not actually do anything yet documentation and the name state otherwise. Either remove the CPU setting frequency API or figure out how to include it in an intuitive way.
Consider we want new users of the PY32 with TinyGo to have a smooth experience and not be confused as to why the CPU frequency has not changed after calling the function that says it changes CPU frequency. If need be have this function do all the reinitialization of all peripherals to fulfill the objective.
There was a problem hiding this comment.
The function was removed - no SetCPUFrequency anymore.
|
@soypat I'm using this PY32F port already for few firmware projects. No change was needed for a month or two, so the code seems to be stable. What do you think about merging it? |
| func SetCPUFrequency(frequency uint32) { | ||
| CPUFrequencyHz = frequency | ||
| } |
There was a problem hiding this comment.
This API is still very unintuitive because it does exactly none of what it says it does. Calling this function does not actually do anything yet documentation and the name state otherwise. Either remove the CPU setting frequency API or figure out how to include it in an intuitive way.
Consider we want new users of the PY32 with TinyGo to have a smooth experience and not be confused as to why the CPU frequency has not changed after calling the function that says it changes CPU frequency. If need be have this function do all the reinitialization of all peripherals to fulfill the objective.
| } | ||
|
|
||
| // Configure pin for use by UART | ||
| func ConfigureUARTPin(pin Pin, af uint8) { |
There was a problem hiding this comment.
Non default pins can be configured with the UARTConfig struct. Please unexport this.
| for uart.Bus.SR.Get()&py32.USART_SR_TXE == 0 { | ||
| } |
There was a problem hiding this comment.
I missed these hot loops. can we take measures to prevent runaway spinning?
| for uart.Bus.SR.Get()&py32.USART_SR_TC == 0 { | ||
| } |
| func (p Pin) SetAltFunc(af uint8) { | ||
| port, pin := p.getPort() | ||
| if pin >= 8 { | ||
| port.AFRH.ReplaceBits(uint32(af), 0xF, (pin%8)*4) | ||
| } else { | ||
| port.AFRL.ReplaceBits(uint32(af), 0xF, (pin%8)*4) | ||
| } | ||
| } |
There was a problem hiding this comment.
I'm still very confused as to why these APIs are here. I am not familiar with the py32. Maybe documenting them here would clarify to me and future users how to use Altfuncs on the py32 and also maybe give me clarity to suggest alternative APIs?
There was a problem hiding this comment.
This is how you configure a pin for an alternative function, such as UART RX or ADC IN.
There was a problem hiding this comment.
OK, I think we can approach the UART config of pins like RP2040 does it:
type pinFunc: https://github.com/tinygo-org/tinygo/blob/dev/src/machine/machine_rp2_gpio.go#L59setPinFunc: https://github.com/tinygo-org/tinygo/blob/dev/src/machine/machine_rp2_gpio.go#L145-L152- pinfunc definitions for RP2040:
tinygo/src/machine/machine_rp2_2040.go
Lines 99 to 124 in 1a1506e
- uart config of pins: https://github.com/tinygo-org/tinygo/blob/dev/src/machine/machine_rp2_uart.go#L53-L57
what do you think?
There was a problem hiding this comment.
FYI: The exported API is PinMode:
tinygo/src/machine/machine_rp2_2040.go
Lines 36 to 46 in 1a1506e
Update submodule to fix duplicate SetIDCODE/GetIDCODE method declarations in the generated py32f002bxx.go device file. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…tion in UART setup
Add a per-instance setup func to the UART type so the driver is no longer hardwired to USART1. DefaultUART stays USART1; add UART2 (USART2) in a separately build-tagged file since py32f002x parts lack USART2. RX IRQ handlers reference runtime-assigned vars to break the init cycle, and setup is assigned in the var initializer so it runs before InitSerial. Add the py32f003_32k_4k target (32K flash / 4K RAM).
Use CMSIS/pyocd device names for target files and build tags. Add all F003 and F030 densities plus F002A/B, correct F002B to 24K flash and its own startup file, fix the F030x8 pyocd target, and update Embedfire inheritance.
| // must update this value after the new clock is stable, then reconfigure | ||
| // SysTick and any peripherals derived from the system clock. Assigning this | ||
| // variable does not configure the clock hardware. | ||
| var CPUFrequencyHz uint32 = defaultCPUFrequencyHz |
There was a problem hiding this comment.
Please remove/unexport this. I invite you to implement your own HAL for setting the CPU frequency outside of TinyGo. We need to talk about adding/changing HALs before adding them in multi-thousand line CLs. Its too much for one place. Remove all other non-standard HAL as well please to make our life easier.
There was a problem hiding this comment.
What do you mean by "outside of TinyGo", please? We have touched this few times already. There definitely need to be a possibility to configure clock low-level way (by direct register manipulation) and thus there needs to be a variable holding that clock speed to be read by other parties (UART, system timer etc...)
There was a problem hiding this comment.
OK. The way I see it having an exported global variable is a hard no. The best way I can think of moving this along is unexporting this variable and having an unexported function that sets it that we expose via a compiler pragma like //go:linkname from your application. This is done often enough in TinyGo that you should be able to find several examples of how this works in our codebase. The most pertinent example is the net.useNetdev https://github.com/tinygo-org/net/blob/1638a8751255b9d3afe761b8633d94f90a79e91e/netdev.go#L36
which drivers repo links and so do external projects like lneto https://github.com/soypat/lneto/blob/main/x/netdev/gonet-tinygo.go#L11. This way we do not expose any API we have not "approved" but we do not outright just block the useful feature of dynamically setting CPU frequency.
There was a problem hiding this comment.
That sounds kinda hacky, but I take it :) I will change it to unexported function.
Do you have any deadline for that 1.27 release we could merge this in?
There was a problem hiding this comment.
Yes, as soon as possible please! We are trying to target the next release in the next 24 hours, hopefully.
|
|
||
| const ( | ||
| PinOutput PinMode = iota | ||
| PinInputFloating |
There was a problem hiding this comment.
I think PinInput is standard tinygo HAL for floating inputs unless I've missed something.
| // 4-bit field in the GPIO alternate-function registers. The register is split | ||
| // in two: AFRL holds the 4-bit selectors for pins 0–7 and AFRH holds them for | ||
| // pins 8–15, with each selector at bit offset (pin%8)*4 within its register. | ||
| // | ||
| // Alternate-function mappings vary by pin and PY32 variant; consult the | ||
| // device datasheet for the AF0-AF15 mapping. The pin must also be configured | ||
| // as PinAlternate via Pin.Configure before the alternate function takes effect. |
There was a problem hiding this comment.
The register is split ...
There are so many words and the only actual useful part for a user is "Pin must be configured as PinAlternate". Be considerate of user's time reading comments.
| // Each pin supports up to 16 alternate functions (AF0–AF15), encoded as a | ||
| // 4-bit field in the GPIO alternate-function registers. The register is split | ||
| // in two: AFRL holds the 4-bit selectors for pins 0–7 and AFRH holds them for | ||
| // pins 8–15, with each selector at bit offset (pin%8)*4 within its register. | ||
| // | ||
| // Alternate-function mappings vary by pin and PY32 variant; consult the | ||
| // device datasheet for the AF0-AF15 mapping. The pin must also be configured | ||
| // as PinAlternate via Pin.Configure before the alternate function takes effect. |
|
|
||
| // Configure SysTick to fire every 1ms on given system frequency. | ||
| // This should be called after any change to the system clock frequency. | ||
| func ConfigureSystemTimer() { |
There was a problem hiding this comment.
Same as CPUFrequencyHz. Lets talk about new HAL before adding.

Hi, this is a port of of Puya PY32F super-cheap micro-controllers.
There are two new boards and supported (available on Aliexpress) for PY32F030 and PY32002b.
PY32F030 and PY32002b are supported, PY32F002a and PY32F071 will follow.
It follows the STM32 SVD pattern - there's a small TinyGo SVD repository dependent on Rust py32-rs repo. The repository is here: https://github.com/burgrp/py32-svd . I think it would be worth to move it to tinygo-org.