Skip to content

Commit 7d6a325

Browse files
committed
Updated porting document
1 parent d0e3fcd commit 7d6a325

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

AslFastPin/PORTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
== Setting up the basic files/folders ==
44

5-
* Create platform directory (e.g. platforms/arm/kl26)
6-
* Create configuration header led_sysdefs_arm_kl26.h:
7-
* Define platform flags (like FASTLED_ARM/FASTLED_TEENSY)
5+
* Create platform directory (e.g. utility/arm/kl26)
6+
* Create configuration header fastpin_sysdefs_arm_kl26.h:
7+
* Define platform flags (like FASTPIN_ARM/FASTPIN_TEENSY)
88
* Define configuration parameters re: interrupts, or clock doubling
9-
* Include extar system header files if needed
10-
* Create main platform include, fastled_arm_kl26.h
9+
* Include extra system header files if needed
10+
* Create main platform include, fastpin_platform_arm_kl26.h
1111
* Include the various other header files as needed
12-
* Modify led_sysdefs.h to conditionally include platform sysdefs header file
13-
* Modify platforms.h to conditionally include platform fastled header
12+
* Modify fastpin_sysdefs.h to conditionally include platform sysdefs header file
13+
* Modify fastpin_platforms.h to conditionally include platform fastled header
1414

1515
== Porting fastpin.h ==
1616

17-
The heart of the FastLED library is the fast pin accesss. This is a templated class that provides 1-2 cycle pin access, bypassing digital write and other such things. As such, this will usually be the first bit of the library that you will want to port when moving to a new platform. Once you have FastPIN up and running then you can do some basic work like testing toggles or running bit-bang'd SPI output.
17+
The heart of the FastPin library is the fast pin accesss. This is a templated class that provides 1-2 cycle pin access, bypassing digital write and other such things. As such, this will usually be the first bit of the library that you will want to port when moving to a new platform. Once you have FastPin up and running then you can do some basic work like testing toggles or running bit-bang'd SPI output.
1818

19-
There's two low level FastPin classes. There's the base FastPIN template class, and then there is FastPinBB which is for bit-banded access on those MCUs that support bitbanding. Note that the bitband class is optional and primarily useful in the implementation of other functionality internal to the platform. This file is also where you would do the pin to port/bit mapping defines.
19+
There's two low level FastPin classes. There's the base FastPin template class, and then there is FastPinBB which is for bit-banded access on those MCUs that support bitbanding. Note that the bitband class is optional and primarily useful in the implementation of other functionality internal to the platform. This file is also where you would do the pin to port/bit mapping defines.
2020

2121
Explaining how the macros work and should be used is currently beyond the scope of this document.

0 commit comments

Comments
 (0)