updated some documentation

Author: Squantor

README.md

@@ -1,25 +1,37 @@
-# LibMcuLL
-This repository contains the microcontroller lowlevel library, called libMcuLL. It is a inspired by many microcontroller vendor libraries like LPCopen, STM32 LL drivers and many many more. The biggest problem is that they are locked behind various tools and instead of installing many graphical tools that download various zip files I just want to get at the register definitions. Next to that, these libraries are sometimes bloated and a bit inefficient, so lets reinvent the wheel ;-).
+# LibMcu
+This repository contains a set of libraries for usage on various microcontrollers. It is inspired by many microcontroller vendor libraries like LPCopen, STM32 LL drivers and many many more. The biggest problem is that they are locked behind various tools and instead of installing graphical tools that download various zip files I just want to get at the register definitions. Next to that, these libraries are can be big and inefficient, so lets reinvent the wheel ;-).
+All of these libraries are written in C++20.
+This library encompasses three separate libraries:
+* LibMcuLL: Contains low level routines that expose as much as the microcontroller functionality with a specific API
+* LibMcuHal: Contains low level routines that expose some of the microcontroller functionality but with a common interface that should be the same across all supported microcontrollers
+* LibMcuDriver: Contains drivers using the LibMcuHal classes so are usable across all microcontroller families.
 # Usage
 To use this project add the inc directory of this repository to your project and to access the register definitions define the microcontroller with a preprocessor define in the shape of ```MCU_DEVICECODE```. See the appropriate header for supported controller. Word of warning, that it is defined there does not mean the support is by any means complete. I tend to add register definitions/features when I need them at that moment, yes this is annoying but feel free to contribute if you are missing something.
-## Minimal usage example in C
+## Uusage example in C++
+Just include the microcontroller specific library with the proper postfix notation for HAL or LL library. For example including the RP2040 LL library:
 ```
-// TODO add your configuration options here
-#include <mcu_ll.h>
+// Before inclusion add your clocking configuration in #defines, this will change in the future by using a proper configuration structure
+#include <libmcuRP2040ll.hpp>
 ```
-## Minimal usage example in C++
+If you want to use the HAL library:
 ```
-// TODO add your configuration options here
-#include <mcu_ll.hpp>
+// Before inclusion add your clocking configuration in #defines, this will change in the future by using a proper configuration structure
+#include <libmcuRP2040hal.hpp>
 ```
+The drivers are located in the ```drivers``` 
 ## Design documents
 * How to add a microcontroller (TODO)
 * Hardware in the loop tests (TODO)
 * [include architecture](doc/includes.md)
-* [C Coding guidelines](doc/C_coding_guidelines.md)
 * [C++ Coding guidelines](doc/CPP_coding_guidelines.md)
-* [C++ namespacing](doc/CPP_namespaces.md)
-* C++ anatomy of a peripheral hardware definition (TODO)
-* C++ anatomy of a peripheral software definition (TODO)
+* [namespacing](doc/CPP_namespaces.md)
+* design of a low level peripheral hardware definition (TODO)
+* design of a low level peripheral software definition (TODO)
+* design of a HAL peripheral definition (TODO)
+* design of a driver (TODO)
 # Goals
-For version 0.1 I intend to support the all the LPC812 peripherals with some functionality to make some applications. Not all features will be supported on all peripherals.
+Support is based on the microcontrollers I use the most, support is spotty as this library is still in development. Peripheral support is based on a first use basis.
+* NXP LPC8 series like the LPC81X, LPC82X, LPC80X, LPC84X, LPC11XX
+* STM32F0 STM32G0 STM32C0 STM32F4 STM32F7
+* RP2040
+I add support for peripherals on a project by project need basis. I use this library mostly as a learning vehicle for using modern C++. If you have a need, feel free to submit a pullrequest.

doc/CPP_namespaces.md

@@ -1,7 +1,13 @@
-# C++ LibMcuLL namespaces
-C++ LibMcuLL uses namespaces to group various definitions.
-* ```libMcuLL``` is the top level namespace that contains LibMcuLL types and helper classes
+# C++ libMcu namespaces
+C++ libMcu uses namespaces to group various definitions.
+* ```libMcu``` contains types, definitions and helper classe used libMcu wide
+* ```libMcuLL``` is the top level namespace that contains libMcuLL types and helper classes
   * ```hw``` contains hardware definitions like the peripheral addresses
     * ```peripheral``` contains the defintions for this peripheral
       * ```REGISTER``` contains the defintions for this peripheral register
-  * ```sw``` contains software definitions like classes, enums used as method arguments
+  * ```sw``` contains software definitions like peripheral control classes, enums used as method arguments
+ * ```libMcuHal``` is the top level namespace that contains libMcuHal types and helper classes
+   * ```peripheral``` contains the HAL control class for this peripheral. The class name is the same as the namespace name
+ * ```libMcuDriver``` is the top level namespace that contain libMcuDriver types and helper classes
+   * ```driver``` contains the driver control class. The class name is the same as the namespace name
+