free-pdk / free-pdk.github.io

Source of the Free PDK documentation website.

Free PDK Online Documentation

This repository holds the source of the documentation available at https://free-pdk.github.io/.

Local Setup

This site uses Jekyll. Jekyll is a static site generator that takes markdown files and transforms them to HTML.

To run Jekyll locally, install ruby >=2.5.0 and the bundler gem (gem install bundler). Then install dependencies by running bundle install and build the site by calling bundle exec jekyll serve --livereload. (You may have to use bundle exec jekyll serve --livereload --no-watch if you are running WSL.)

We use the GitHub API to fetch a list of projects using Padauk µCs and the latest activity in the free-pdk organization. The API has a rate limit of 60 requests per hour for unauthenticated requests, which may not be sufficient for the amount of API requests we make when building the website. Please set a GITHUB_TOKEN environment variable with a personal access token you can create here (no scopes necessary). If you don't set a GITHUB_TOKEN environment variable, we automatically make less requests to the API, but some features like detecting projects using Padauk's proprietary toolchain will be skipped.

Deployment

Every commit on the production branch is built and deployed by a GitHub Action and the result is force-pushed to the gh-pages branch, which is deployed to https://free-pdk.github.io by GitHub Pages.

The production branch is also automatically deployed by netlify to https://free-pdk-preview.netlify.app/. Logs can be viewed by clicking on this badge:

All pull requests are also built and deployed by netlify so that you can easily review pull requests without having to check them out locally.

There is one difference between the versions deployed to netlify and the version deployed to GitHub Pages: All URLs on netlify are automatically transformed to lower case, whereas URLs on GitHub Pages are case sensitive. For example, the URL /chips/PFS173 works as expected on GitHub Pages and redirects to /chips/pfs173 on netlify, whereas the URL /chips/pfs173 works on netlify but returns 404 on GitHub Pages.

free-pdk.github.io's Issues

Layout tweak

@cmfcmf - Thanks for adding the datasheet! The layout for the first column is looking a bit cramped now (taking up three lines with three different links). Maybe it would be better to break out the Datasheet and Padauk links into a separate column at this point?

So, first column header would become 'MCU' instead of 'Padauk MCU' and just contain the device name with a link to the chip detail page. And, add a column to the end that is 'Padauk Links' and has the Datasheet and @padauk product page links.

If we are looking for more space to be able to add a new column, we might be able to shrink the 'OSS Support' header down a bit as well.

Pinout images are truncated when saving them in firefox

@cmfcmf, this is how it looks:

Workflow was disabled due to inactivity of repo

@cmfcmf

I noticed that the links to the datasheets are outdated on the website. It seems the github action to rebuild the website had been automatically deactivated due to inactivity in the repository for 60 days - two years ago!

I reactivated the scheduled run, but I am not sure that is all there is to it. Let's see if it passes.

PFS122 not showing up

I updated https://github.com/free-pdk/fppa-pdk-documentation/blob/master/PADAUK_FPPA_14_bit_instruction_set.wikitext; how do I get the new data to show up at https://free-pdk.github.io/instruction-sets/PDK14?

where are the information for G Series( MTP (Flash + EEPROM)) ?

hello,
in the chips directory there's a mention of G series paduak mcus with EEPROM support.

1. does free pdk support flashing these chips?
2. where can I buy them ? i didn't find anything on google or their website.

thanks

Drop development branch

I don't think we necessarily need both a development and production branch. It adds an extra step of unnecessary complexity and it also breaks the GitHub Action that refreshes the community projects once per day, which always deploys the default (= development) branch. This is why some changes from the development branch are already live at free-pdk.github.io, even though development has not yet been merged into production.

I would therefore like to delete the production branch and rename the development branch to production. Would that be okay with you?

Convert uC-specific Information and Pinouts to a table

I think it would look better, and we could fit more information, if the following section was converted to a table:

Maybe, something like this:

Padauk MCU	IO (max)	Ins. Set	ROM	RAM	Timers	PWM	COMP	ADC	Special	Datasheet
PFS154	14	14-bit	2KW Flash	128 bytes	T16, T2, T3	2x 8-bit, 3x 11-bit	Yes	-	4x LCD	Datasheet
PFS172	14	14-bit	2KW Flash	128 bytes	T16, T2, T3	2x 8-bit	Yes	12x 8-bit	-	Datasheet
PFS173	18	15-bit	3KW Flash	256 bytes	T16, T2, T3	2x 8-bit, 3x 11-bit	Yes	13x 8-bit	5x LCD	Datasheet
PMS15A	6	13-bit	0.5KW OTP	64 bytes	T16, T2	1x 8-bit	Yes	-	-	Datasheet
PMS150C	6	13-bit	1KW OTP	64 bytes	T16, T2	1x 8-bit	Yes	-	-	Datasheet
PMS152	14	14-bit	1.25KW OTP	80 bytes	T16, T2	1x 8-bit, 3x 11-bit	Yes	-	-	Datasheet
PMS154C	14	14-bit	2KW OTP	128 bytes	T16, T2, T3	1x 8-bit, 3x 11-bit	Yes	-	4x LCD	Datasheet
PMS171B	14	14-bit	1.5KW OTP	96 bytes	T16, T2, T3	1x 8-bit	Yes	11x 8-bit	-	Datasheet

Use netlify for PR previews

I would like to setup netlify for PR previews like discussed in #3

To do that, netlify needs read access to this repository, but a repository admin first needs to approve that (you should've recevied an email).

Add link to datasheets

How do we feel about adding a link to the datasheet for each IC?

If so, should it be a direct link to the .PDF hosted on Padauk's website (i.e. http://www.padauk.com.tw/upload/doc/PFS173%20datasheet_v105_EN_20200619.pdf), or would we be able to re-host them and link directly?

I could see the link going on the chip's 'detail' page under the 'Official Product Page' link, and also maybe as an icon on the primary page next to all the badges (hopefully to be converted to a table soon).

There is no such thing as PMS15A

I have some PMS15A and when you read them out you can see that infact they are PMS150C (same hardware ID, amount of program memory is same, ...)

PMS15A is just a marketing name of PMS150C. Inside the IC is the exact same silicon. Not a single difference.

Only the PADAUK IDE is limiting the amount of code you can use in case you choose PMS15A. If you choose PMS150C then you can use the complete code memory (1K). Also original PADAUK WRITER happily writes the PMS150C code to a "PMS15A"... and of course, everything is working.

Not all repositories showing up in search results

I recently created a new repository for an (old) project, which I had not published in a dedicated repository yet.

https://github.com/cpldcpu/Addressable_7-Segment

Interestingly it is not showing up on the free-pdk page. The reason for that is that it is not showing up in the Github search results despite having the topic "padauk". I suspect that there is some kind of metric that excludes too new repositories or repositories that look like forks.

Curious indeed. I wonder what is triggering this.

Update chips/index.md

@freepdk made a comment here: 1667faf#r40725763

MCU390 is supported by easy pdk prog, I have some at hand.

Looks like MCU39X is a customized PADAUK version from this company:
http://www.zhienchina.com/products/1556.html
The chip comes with SDK for touch sensing: http://www.zhienchina.com/Upfiles/down/%E8%8A%AF%E8%BE%BE%E8%A7%A6%E6%91%B8MCU39x.rar

They also have the XDM varaints (see above) with integrated eeprom (looks like a multichip package - 2 ics in one package):
http://www.zhienchina.com/product/MCU.html

Sorry for hickup with merges

Sorry, the github plugin for VSCODE introduced a very confusing unintential merge when I tried to pull the latestest production branch:

I tried to roll it back but noticed that this actually reverted to an older version, so I reverted the reversion.

Looking into whats going on, I hope the current state is the right one.

Detect Padauk projects that were created with the official IDE and add a note in the project list

Projects created with the official IDE can be recognized by looking for the *.PRJ or *.PRE extension in the repository. There may be a few false positives, so it would be advisable not to use this classifier to segregate files. Instead, a note could be added instead.

One alternative proposal could be to ask to add the topic "Free-PDK" to the repositority if the project is based on the OSS tool-chain and feature those repositories, for example by prioritizing them in the order or by adding flair or similar layout elements.

Add support for PMS171B

PMS171B has easy-pdk-programmer-software support in the development branch.

We should add it to the website as well and make sure we have specs and pinouts available.

Remove .html extension

Might be nice to remove the .html extensions (like most newer websites are doing).

It already seems to work in the browser, but Jekyll probably needs a configuration change to truly support this:
https://medium.com/@mittalyashu/how-to-remove-html-extension-in-jekyll-efeb48bd725f