From 9f95ff5b6ba01db09552b84a0ab79607060a2666 Mon Sep 17 00:00:00 2001 From: Ali Labbene Date: Wed, 11 Dec 2019 08:59:21 +0100 Subject: Official ARM version: v5.4.0 Add CMSIS V5.4.0, please refer to index.html available under \docs folder. Note: content of \CMSIS\Core\Include has been copied under \Include to keep the same structure used in existing projects, and thus avoid projects mass update Note: the following components have been removed from ARM original delivery (as not used in ST packages) - CMSIS_EW2018.pdf - .gitattributes - .gitignore - \Device - \CMSIS - \CoreValidation - \DAP - \Documentation - \DoxyGen - \Driver - \Pack - \RTOS\CMSIS_RTOS_Tutorial.pdf - \RTOS\RTX - \RTOS\Template - \RTOS2\RTX - \Utilities - All ARM/GCC projects files are deleted from \DSP, \RTOS and \RTOS2 Change-Id: Ia026c3f0f0d016627a4fb5a9032852c33d24b4d3 --- docs/Driver/html/group__common__drv__gr.html | 232 +++++++++++++++++++++++++++ 1 file changed, 232 insertions(+) create mode 100644 docs/Driver/html/group__common__drv__gr.html (limited to 'docs/Driver/html/group__common__drv__gr.html') diff --git a/docs/Driver/html/group__common__drv__gr.html b/docs/Driver/html/group__common__drv__gr.html new file mode 100644 index 0000000..ed11ff3 --- /dev/null +++ b/docs/Driver/html/group__common__drv__gr.html @@ -0,0 +1,232 @@ + + + + + +Common Driver Definitions +CMSIS-Driver: Common Driver Definitions + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-Driver +  Version 2.6.0 +
+
Peripheral Interface for Middleware and Application Code
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Content | +Data Structures | +Enumerations
+
+
Common Driver Definitions
+
+
+ +

Definitions common in all driver interfaces (Driver_Common.h) +More...

+ + + + + +

+Content

 Status Error Codes
 Negative return values of functions indicate errors occurred during execution.
 
+ + + + +

+Data Structures

struct  ARM_DRIVER_VERSION
 Driver Version. More...
 
+ + + + +

+Enumerations

enum  ARM_POWER_STATE {
+  ARM_POWER_OFF, +
+  ARM_POWER_LOW, +
+  ARM_POWER_FULL +
+ }
 General power states. More...
 
+

Description

+

Definitions common in all driver interfaces (Driver_Common.h)

+

The following definitions are common in all CMSIS-Driver interfaces. Refer to Common Driver Functions for a general overview.

+

Data Structure Documentation

+ +
+
+ + + + +
struct ARM_DRIVER_VERSION
+
+

Driver Version.

+

The access structure of each CMSIS-Driver provides the function GetVersion, which returns in the struct ARM_DRIVER_VERSION:

+
    +
  • API version, which is the version of the CMSIS-Driver specification used to implement this driver.
    • +
  • Driver version, which is the source code version of the actual driver implementation.
    • +
+

The version is encoded as 16-bit unsigned value (uint16_t) with:

+
    +
  • high-byte: major version.
    • +
  • low-byte: minor version.
    • +
+

For example, version 1.12 is encoded as 0x10C.

+
+ + + + + + + +
Data Fields
+uint16_t +api +API version.
+uint16_t +drv +Driver version.
+ +
+
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum ARM_POWER_STATE
+
+ +

General power states.

+

The access structure of each CMSIS-Driver provides the function PowerControl, which handles the power profile for a peripheral using the parameter ARM_POWER_STATE. Depending on this parameter, the peripheral will operate at full speed, detect just events, or is completely un-powered.

+

Refer to Function Call Sequence for more information.

+ + + + +
Enumerator
ARM_POWER_OFF  +

Power off: no operation possible.

+
ARM_POWER_LOW  +

Low Power mode: retain state, detect and signal wake-up events.

+
ARM_POWER_FULL  +

Power on: full operation at maximum performance.

+
+ +
+
+
+
+ + + + -- cgit