hal/include/HAL/Interrupts.h

/*----------------------------------------------------------------------------*/
/* Copyright (c) FIRST 2016. All Rights Reserved.                             */
/* Open Source Software - may be modified and shared by FRC teams. The code   */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project.                                                               */
/*----------------------------------------------------------------------------*/

#pragma once

#include <stdint.h>

#include "HAL/AnalogTrigger.h"
#include "HAL/Types.h"

#ifdef __cplusplus
extern "C" {
#endif
typedef void (*HAL_InterruptHandlerFunction)(uint32_t interruptAssertedMask,
                                             void* param);

HAL_InterruptHandle HAL_InitializeInterrupts(HAL_Bool watcher, int32_t* status);
void HAL_CleanInterrupts(HAL_InterruptHandle interruptHandle, int32_t* status);

int64_t HAL_WaitForInterrupt(HAL_InterruptHandle interruptHandle,
                             double timeout, HAL_Bool ignorePrevious,
                             int32_t* status);
void HAL_EnableInterrupts(HAL_InterruptHandle interruptHandle, int32_t* status);
void HAL_DisableInterrupts(HAL_InterruptHandle interruptHandle,
                           int32_t* status);
double HAL_ReadInterruptRisingTimestamp(HAL_InterruptHandle interruptHandle,
                                        int32_t* status);
double HAL_ReadInterruptFallingTimestamp(HAL_InterruptHandle interruptHandle,
                                         int32_t* status);
void HAL_RequestInterrupts(HAL_InterruptHandle interruptHandle,
                           HAL_Handle digitalSourceHandle,
                           HAL_AnalogTriggerType analogTriggerType,
                           int32_t* status);
void HAL_AttachInterruptHandler(HAL_InterruptHandle interruptHandle,
                                HAL_InterruptHandlerFunction handler,
                                void* param, int32_t* status);
void HAL_SetInterruptUpSourceEdge(HAL_InterruptHandle interruptHandle,
                                  HAL_Bool risingEdge, HAL_Bool fallingEdge,
                                  int32_t* status);
#ifdef __cplusplus
}
#endif
artf2612: Added Python script for updating license in source files (#57) This is a follow-up of 3cd1253. A C++ program was written to automate the license update originally. That program was translated to Python so it can be kept in the repository and run when needed. It has been tested on Windows using the standard Python 3 installation and on Linux. The original version skipped files that had "//" at the beginning since most were files that should be excluded. The relevant files are now in an exclusion list and the rest are processed normally. The .hpp file extension has been added as well. The script rewrote CompressorJNI.cpp to remove the carriage returns from its line endings. 2016-05-25 20:23:37 -07:00			`/----------------------------------------------------------------------------/`
			`/* Copyright (c) FIRST 2016. All Rights Reserved. */`
			`/* Open Source Software - may be modified and shared by FRC teams. The code */`
			`/* must be accompanied by the FIRST BSD license file in the root directory of */`
			`/* the project. */`
			`/----------------------------------------------------------------------------/`

Reverting back to static .a files for C++ and fixing lots of other assorted items 2014-05-02 17:54:01 -04:00			`#pragma once`

			`#include <stdint.h>`

Changes DigitalSource API for HAL ease of use (#144) 2016-07-07 21:43:55 -07:00			`#include "HAL/AnalogTrigger.h"`
Switches HAL to fixed length signed integers, and adds our own HAL_Bool Type (#155) * Switches HAL to fixed length signed integers, and adds our own HAL_Bool type * Replaces HAL Floats with Doubles Doubles are just as fast as floats with optimizations turned on, so switches to all doubles. All made doubles for consistency. * Prepends HAL/ to HAL include files. Also fixes some range errors 2016-07-12 10:45:14 -07:00			`#include "HAL/Types.h"`
Moves Interrupts over to Handles instead of pointers (#99) 2016-06-20 23:22:49 -07:00
Changes HAL Headers to be C compliant. (#171) 2016-07-12 21:53:06 -07:00			`#ifdef __cplusplus`
Add format script which invokes clang-format on the C++ source code (#41) On Windows machines, clang-format.exe must be in the PATH environment variable. 2016-05-20 17:30:37 -07:00			`extern "C" {`
Changes HAL Headers to be C compliant. (#171) 2016-07-12 21:53:06 -07:00			`#endif`
Switches notifier to use a typedef for the callback, and prepends HAL_ to InterruptHandlerFunction (#216) 2016-09-05 07:31:51 -07:00			`typedef void (*HAL_InterruptHandlerFunction)(uint32_t interruptAssertedMask,`
			`void* param);`
Reverting back to static .a files for C++ and fixing lots of other assorted items 2014-05-02 17:54:01 -04:00
Switches HAL to fixed length signed integers, and adds our own HAL_Bool Type (#155) * Switches HAL to fixed length signed integers, and adds our own HAL_Bool type * Replaces HAL Floats with Doubles Doubles are just as fast as floats with optimizations turned on, so switches to all doubles. All made doubles for consistency. * Prepends HAL/ to HAL include files. Also fixes some range errors 2016-07-12 10:45:14 -07:00			`HAL_InterruptHandle HAL_InitializeInterrupts(HAL_Bool watcher, int32_t* status);`
Renamed "pin" to "channel" and variables with underscores now use mixed case (#194) 2016-08-12 13:45:28 -07:00			`void HAL_CleanInterrupts(HAL_InterruptHandle interruptHandle, int32_t* status);`
Reverting back to static .a files for C++ and fixing lots of other assorted items 2014-05-02 17:54:01 -04:00
Renamed "pin" to "channel" and variables with underscores now use mixed case (#194) 2016-08-12 13:45:28 -07:00			`int64_t HAL_WaitForInterrupt(HAL_InterruptHandle interruptHandle,`
Switches HAL to fixed length signed integers, and adds our own HAL_Bool Type (#155) * Switches HAL to fixed length signed integers, and adds our own HAL_Bool type * Replaces HAL Floats with Doubles Doubles are just as fast as floats with optimizations turned on, so switches to all doubles. All made doubles for consistency. * Prepends HAL/ to HAL include files. Also fixes some range errors 2016-07-12 10:45:14 -07:00			`double timeout, HAL_Bool ignorePrevious,`
			`int32_t* status);`
Renamed "pin" to "channel" and variables with underscores now use mixed case (#194) 2016-08-12 13:45:28 -07:00			`void HAL_EnableInterrupts(HAL_InterruptHandle interruptHandle, int32_t* status);`
			`void HAL_DisableInterrupts(HAL_InterruptHandle interruptHandle,`
Prepends all HAL functions with HAL_ (#146) 2016-07-09 00:24:26 -07:00			`int32_t* status);`
Renamed "pin" to "channel" and variables with underscores now use mixed case (#194) 2016-08-12 13:45:28 -07:00			`double HAL_ReadInterruptRisingTimestamp(HAL_InterruptHandle interruptHandle,`
Finishes Prefix Renames (#152) 2016-07-09 01:12:37 -07:00			`int32_t* status);`
Renamed "pin" to "channel" and variables with underscores now use mixed case (#194) 2016-08-12 13:45:28 -07:00			`double HAL_ReadInterruptFallingTimestamp(HAL_InterruptHandle interruptHandle,`
Finishes Prefix Renames (#152) 2016-07-09 01:12:37 -07:00			`int32_t* status);`
Renamed "pin" to "channel" and variables with underscores now use mixed case (#194) 2016-08-12 13:45:28 -07:00			`void HAL_RequestInterrupts(HAL_InterruptHandle interruptHandle,`
Prepends all HAL functions with HAL_ (#146) 2016-07-09 00:24:26 -07:00			`HAL_Handle digitalSourceHandle,`
			`HAL_AnalogTriggerType analogTriggerType,`
			`int32_t* status);`
Renamed "pin" to "channel" and variables with underscores now use mixed case (#194) 2016-08-12 13:45:28 -07:00			`void HAL_AttachInterruptHandler(HAL_InterruptHandle interruptHandle,`
Switches notifier to use a typedef for the callback, and prepends HAL_ to InterruptHandlerFunction (#216) 2016-09-05 07:31:51 -07:00			`HAL_InterruptHandlerFunction handler,`
			`void* param, int32_t* status);`
Renamed "pin" to "channel" and variables with underscores now use mixed case (#194) 2016-08-12 13:45:28 -07:00			`void HAL_SetInterruptUpSourceEdge(HAL_InterruptHandle interruptHandle,`
Switches HAL to fixed length signed integers, and adds our own HAL_Bool Type (#155) * Switches HAL to fixed length signed integers, and adds our own HAL_Bool type * Replaces HAL Floats with Doubles Doubles are just as fast as floats with optimizations turned on, so switches to all doubles. All made doubles for consistency. * Prepends HAL/ to HAL include files. Also fixes some range errors 2016-07-12 10:45:14 -07:00			`HAL_Bool risingEdge, HAL_Bool fallingEdge,`
Prepends all HAL functions with HAL_ (#146) 2016-07-09 00:24:26 -07:00			`int32_t* status);`
Changes HAL Headers to be C compliant. (#171) 2016-07-12 21:53:06 -07:00			`#ifdef __cplusplus`
Reverting back to static .a files for C++ and fixing lots of other assorted items 2014-05-02 17:54:01 -04:00			`}`
Changes HAL Headers to be C compliant. (#171) 2016-07-12 21:53:06 -07:00			`#endif`