[FL-41] api-hal doxygen documentation (#387)
* targets/api-hal: rework documentation in doxygen style * core/api-hal: rework documentation in doxygen style * core/furi: rework documentation in doxygen style * drivers: rework documentation in doxygen style Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
@@ -6,8 +6,10 @@
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** Interrupt callback prototype */
|
||||
typedef void (*InterruptCallback)(void*, void*);
|
||||
|
||||
/** Interupt type */
|
||||
typedef enum {
|
||||
InterruptTypeComparatorTrigger,
|
||||
InterruptTypeTimerCapture,
|
||||
@@ -16,6 +18,7 @@ typedef enum {
|
||||
InterruptTypeExternalInterrupt,
|
||||
} InterruptType;
|
||||
|
||||
/** Interrupt callback type */
|
||||
typedef struct {
|
||||
InterruptCallback callback;
|
||||
InterruptType type;
|
||||
@@ -23,11 +26,46 @@ typedef struct {
|
||||
bool ready;
|
||||
} InterruptCallbackItem;
|
||||
|
||||
/**
|
||||
* Init interrupt
|
||||
* @return true on succsessful initialization, false otherwise
|
||||
*/
|
||||
bool api_interrupt_init();
|
||||
|
||||
/**
|
||||
* Add interrupt
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
* @param context context for callback
|
||||
*/
|
||||
void api_interrupt_add(InterruptCallback callback, InterruptType type, void* context);
|
||||
|
||||
/**
|
||||
* Remove interrupt
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
*/
|
||||
void api_interrupt_remove(InterruptCallback callback, InterruptType type);
|
||||
|
||||
/**
|
||||
* Enable interrupt
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
*/
|
||||
void api_interrupt_enable(InterruptCallback callback, InterruptType type);
|
||||
|
||||
/**
|
||||
* Disable interrupt
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
*/
|
||||
void api_interrupt_disable(InterruptCallback callback, InterruptType type);
|
||||
|
||||
/**
|
||||
* Call interrupt
|
||||
* @param type InterruptType
|
||||
* @param hw pointer to hardware peripheral
|
||||
*/
|
||||
void api_interrupt_call(InterruptType type, void* hw);
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
||||
Reference in New Issue
Block a user