liz/flipperzero-firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[FL-1906] Documentation: add Doxyfile, prepare sources for doxygen. (#741)

Browse Source 
* Documentation: add Doxyfile, prepare sources for doxygen.

* Update ReadMe and remove obsolete CLA

* Add contribution guide

* Contributing: update text

* Correct spelling
This commit is contained in:
あく
2021-10-03 13:36:05 +03:00
committed by GitHub
parent 1208a5077f
commit 89a6c09a7a
66 changed files with 4846 additions and 1224 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
applications/input/input.h
View File

@@ -1,19 +1,24 @@
/**
* @file input.h
* Input: main API
*/
#pragma once
#include <furi-hal-resources.h>
/* Input Types
/** Input Types
* Some of them are physical events and some logical
*/
typedef enum {
InputTypePress, /* Press event, emitted after debounce */
InputTypeRelease, /* Release event, emitted after debounce */
InputTypeShort, /* Short event, emitted after InputTypeRelease done withing INPUT_LONG_PRESS interval */
InputTypeLong, /* Long event, emmited after INPUT_LONG_PRESS interval, asynchronouse to InputTypeRelease */
InputTypeRepeat, /* Repeat event, emmited with INPUT_REPEATE_PRESS period after InputTypeLong event */
InputTypePress, /**< Press event, emitted after debounce */
InputTypeRelease, /**< Release event, emitted after debounce */
InputTypeShort, /**< Short event, emitted after InputTypeRelease done withing INPUT_LONG_PRESS interval */
InputTypeLong, /**< Long event, emmited after INPUT_LONG_PRESS interval, asynchronouse to InputTypeRelease */
InputTypeRepeat, /**< Repeat event, emmited with INPUT_REPEATE_PRESS period after InputTypeLong event */
} InputType;
/* Input Event, dispatches with PubSub */
/** Input Event, dispatches with PubSub */
typedef struct {
uint32_t sequence;
InputKey key;

13
applications/input/input_i.h
View File

@@ -1,3 +1,8 @@
/**
* @file input_i.h
* Input: internal API
*/
#pragma once
#include "input.h"
@@ -16,7 +21,7 @@
#define INPUT_LONG_PRESS_COUNTS 2
#define INPUT_THREAD_FLAG_ISR 0x00000001
/* Input pin state */
/** Input pin state */
typedef struct {
const InputPin* pin;
// State
@@ -27,7 +32,7 @@ typedef struct {
volatile uint32_t counter;
} InputPinState;
/* Input state */
/** Input state */
typedef struct {
osThreadId_t thread;
PubSub event_pubsub;
@@ -36,8 +41,8 @@ typedef struct {
volatile uint32_t counter;
} Input;
/* Input press timer callback */
/** Input press timer callback */
void input_press_timer_callback(void* arg);
/* Input interrupt handler */
/** Input interrupt handler */
void input_isr(void* _ctx);