Mirror
/
klipper-dgus
mirror of https://github.com/Desuuuu/klipper.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Minor micro-controller updates to Code_Overview.md 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2019-11-07 10:08:21 -05:00
parent 2981bd601b
commit 3f338c08c1
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/Code_Overview.md
View File

@ -5,8 +5,8 @@ Directory Layout
================ ================
The **src/** directory contains the C source for the micro-controller The **src/** directory contains the C source for the micro-controller
code. The **src/avr/**, **src/sam3/**, **src/samd21/**, code. The **src/atsam/**, **src/atsamd/**, **src/avr/**,
**src/lpc176x/**, **src/stm32f1/**, **src/pru/**, and **src/linux/** **src/linux/**, **src/lpc176x/**, **src/pru/**, and **src/stm32/**
directories contain architecture specific micro-controller code. The directories contain architecture specific micro-controller code. The
**src/simulator/** contains code stubs that allow the micro-controller **src/simulator/** contains code stubs that allow the micro-controller
to be test compiled on other architectures. The **src/generic/** to be test compiled on other architectures. The **src/generic/**
@ -50,10 +50,11 @@ DECL_TASK() macro.
One of the main task functions is command_dispatch() located in One of the main task functions is command_dispatch() located in
**src/command.c**. This function is called from the board specific **src/command.c**. This function is called from the board specific
input/output code (eg, **src/avr/serial.c**) and it runs the command input/output code (eg, **src/avr/serial.c**,
functions associated with the commands found in the input **src/generic/serial_irq.c**) and it runs the command functions
stream. Command functions are declared using the DECL_COMMAND() macro associated with the commands found in the input stream. Command
(see the [protocol](Protocol.md) document for more information). functions are declared using the DECL_COMMAND() macro (see the
[protocol](Protocol.md) document for more information).
Task, init, and command functions always run with interrupts enabled Task, init, and command functions always run with interrupts enabled
(however, they can temporarily disable interrupts if needed). These (however, they can temporarily disable interrupts if needed). These