work on README.md

master
polymurph 2 years ago
parent 7591635fc7
commit 2eab53cb47

@ -17,6 +17,38 @@ KED is intendet to be used as a git submodule. Allowing the mainternars of KED t
### Before you ask, Of Course, Yes, you would be one of our heroes if you decide to be a contributor !
# What is KED?
KED is a framework created by Kerem Yollu and Edwin Koch. KED stands for
"Kerem and EdwinDevelopement". The idea was initially started by the desire to create a hardware
abstraction Layer (HAL)...
# KED structure
This section will explain how KED is structured and how you can implement drivers, peripherals,
etc.
# Chip Support Layer (CSL)
The CSL folder holds all the target device specific resources and implementations. For example if
you want to use the NUCLEO 042k6 you have to choose the target device "stm32f042k6t6" as this is
the phisical IC used by the NUCLEO board. This target device is represented inside CSL folder as a
folder with the target device name. This is crucial as there can be differeces between different
packages with the same IC core e.g "stm32f042k6t6" vs "stm32f042f6p6". Both of them are the "same"
but have different pin mappings and even differing peripheral structures.
## Implementing new target device
To implement a new target device to KED please follow the following steps in this section. Each
subsection will explaine how the structure is defined and what has to be implemented sothat at the
end there is a fully implemented
## Main structure of target device resources
Each target device has its own folder in which all the resorces and device specific implementations
are located. This folder is located to
in the csl folder of KED
## Implementing Peripherals
First create a folder with the spesific IC name. E.g. stm32f042k6t6 (used on the NUCLEO F042K6).
In this folder
TODO -> explain how to implement periperals and include
INTERFACES
- pin

Loading…
Cancel
Save