Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-06 03:31:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Replace crlf line endings with lf (#1731)

Browse Source
This commit is contained in:
Austin Shalit
2019-06-28 23:55:14 -04:00
committed by Peter Johnson
parent b6d5d90d9d
commit f7cfdd7cee
21 changed files with 922 additions and 922 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
hal/src/generate/FRCNetComm.java.in
View File

@@ -1,33 +1,33 @@
/*
* Autogenerated file! Do not manually edit this file.
*/
package edu.wpi.first.hal;
/**
* JNI wrapper for library <b>FRC_NetworkCommunication</b><br>.
*/
@SuppressWarnings({"MethodName", "LineLength"})
public class FRCNetComm {
/**
* Resource type from UsageReporting.
*/
@SuppressWarnings({"TypeName", "PMD.ConstantsInInterface"})
public static final class tResourceType {
private tResourceType() {
}
${usage_reporting_types}
}
/**
* Instances from UsageReporting.
*/
@SuppressWarnings({"TypeName", "PMD.ConstantsInInterface"})
public static final class tInstances {
private tInstances() {
}
${usage_reporting_instances}
}
}
/*
* Autogenerated file! Do not manually edit this file.
*/
package edu.wpi.first.hal;
/**
* JNI wrapper for library <b>FRC_NetworkCommunication</b><br>.
*/
@SuppressWarnings({"MethodName", "LineLength"})
public class FRCNetComm {
/**
* Resource type from UsageReporting.
*/
@SuppressWarnings({"TypeName", "PMD.ConstantsInInterface"})
public static final class tResourceType {
private tResourceType() {
}
${usage_reporting_types}
}
/**
* Instances from UsageReporting.
*/
@SuppressWarnings({"TypeName", "PMD.ConstantsInInterface"})
public static final class tInstances {
private tInstances() {
}
${usage_reporting_instances}
}
}

28
hal/src/generate/FRCUsageReporting.h.in
View File

@@ -1,14 +1,14 @@
#pragma once
/*
* Autogenerated file! Do not manually edit this file.
*/
namespace HALUsageReporting {
typedef enum {
${usage_reporting_types_cpp}
} tResourceType;
typedef enum {
${usage_reporting_instances_cpp}
} tInstances;
}
#pragma once
/*
* Autogenerated file! Do not manually edit this file.
*/
namespace HALUsageReporting {
typedef enum {
${usage_reporting_types_cpp}
} tResourceType;
typedef enum {
${usage_reporting_instances_cpp}
} tInstances;
}

88
hal/src/generate/Instances.txt
View File

@@ -1,44 +1,44 @@
kLanguage_LabVIEW = 1
kLanguage_CPlusPlus = 2
kLanguage_Java = 3
kLanguage_Python = 4
kLanguage_DotNet = 5
kCANPlugin_BlackJagBridge = 1
kCANPlugin_2CAN = 2
kFramework_Iterative = 1
kFramework_Simple = 2
kFramework_CommandControl = 3
kFramework_Timed = 4
kFramework_ROS = 5
kFramework_RobotBuilder = 6
kRobotDrive_ArcadeStandard = 1
kRobotDrive_ArcadeButtonSpin = 2
kRobotDrive_ArcadeRatioCurve = 3
kRobotDrive_Tank = 4
kRobotDrive_MecanumPolar = 5
kRobotDrive_MecanumCartesian = 6
kRobotDrive2_DifferentialArcade = 7
kRobotDrive2_DifferentialTank = 8
kRobotDrive2_DifferentialCurvature = 9
kRobotDrive2_MecanumCartesian = 10
kRobotDrive2_MecanumPolar = 11
kRobotDrive2_KilloughCartesian = 12
kRobotDrive2_KilloughPolar = 13
kDriverStationCIO_Analog = 1
kDriverStationCIO_DigitalIn = 2
kDriverStationCIO_DigitalOut = 3
kDriverStationEIO_Acceleration = 1
kDriverStationEIO_AnalogIn = 2
kDriverStationEIO_AnalogOut = 3
kDriverStationEIO_Button = 4
kDriverStationEIO_LED = 5
kDriverStationEIO_DigitalIn = 6
kDriverStationEIO_DigitalOut = 7
kDriverStationEIO_FixedDigitalOut = 8
kDriverStationEIO_PWM = 9
kDriverStationEIO_Encoder = 10
kDriverStationEIO_TouchSlider = 11
kADXL345_SPI = 1
kADXL345_I2C = 2
kCommand_Scheduler = 1
kSmartDashboard_Instance = 1
kLanguage_LabVIEW = 1
kLanguage_CPlusPlus = 2
kLanguage_Java = 3
kLanguage_Python = 4
kLanguage_DotNet = 5
kCANPlugin_BlackJagBridge = 1
kCANPlugin_2CAN = 2
kFramework_Iterative = 1
kFramework_Simple = 2
kFramework_CommandControl = 3
kFramework_Timed = 4
kFramework_ROS = 5
kFramework_RobotBuilder = 6
kRobotDrive_ArcadeStandard = 1
kRobotDrive_ArcadeButtonSpin = 2
kRobotDrive_ArcadeRatioCurve = 3
kRobotDrive_Tank = 4
kRobotDrive_MecanumPolar = 5
kRobotDrive_MecanumCartesian = 6
kRobotDrive2_DifferentialArcade = 7
kRobotDrive2_DifferentialTank = 8
kRobotDrive2_DifferentialCurvature = 9
kRobotDrive2_MecanumCartesian = 10
kRobotDrive2_MecanumPolar = 11
kRobotDrive2_KilloughCartesian = 12
kRobotDrive2_KilloughPolar = 13
kDriverStationCIO_Analog = 1
kDriverStationCIO_DigitalIn = 2
kDriverStationCIO_DigitalOut = 3
kDriverStationEIO_Acceleration = 1
kDriverStationEIO_AnalogIn = 2
kDriverStationEIO_AnalogOut = 3
kDriverStationEIO_Button = 4
kDriverStationEIO_LED = 5
kDriverStationEIO_DigitalIn = 6
kDriverStationEIO_DigitalOut = 7
kDriverStationEIO_FixedDigitalOut = 8
kDriverStationEIO_PWM = 9
kDriverStationEIO_Encoder = 10
kDriverStationEIO_TouchSlider = 11
kADXL345_SPI = 1
kADXL345_I2C = 2
kCommand_Scheduler = 1
kSmartDashboard_Instance = 1

170
hal/src/generate/ResourceType.txt
View File

@@ -1,85 +1,85 @@
kResourceType_Controller = 0
kResourceType_Module = 1
kResourceType_Language = 2
kResourceType_CANPlugin = 3
kResourceType_Accelerometer = 4
kResourceType_ADXL345 = 5
kResourceType_AnalogChannel = 6
kResourceType_AnalogTrigger = 7
kResourceType_AnalogTriggerOutput = 8
kResourceType_CANJaguar = 9
kResourceType_Compressor = 10
kResourceType_Counter = 11
kResourceType_Dashboard = 12
kResourceType_DigitalInput = 13
kResourceType_DigitalOutput = 14
kResourceType_DriverStationCIO = 15
kResourceType_DriverStationEIO = 16
kResourceType_DriverStationLCD = 17
kResourceType_Encoder = 18
kResourceType_GearTooth = 19
kResourceType_Gyro = 20
kResourceType_I2C = 21
kResourceType_Framework = 22
kResourceType_Jaguar = 23
kResourceType_Joystick = 24
kResourceType_Kinect = 25
kResourceType_KinectStick = 26
kResourceType_PIDController = 27
kResourceType_Preferences = 28
kResourceType_PWM = 29
kResourceType_Relay = 30
kResourceType_RobotDrive = 31
kResourceType_SerialPort = 32
kResourceType_Servo = 33
kResourceType_Solenoid = 34
kResourceType_SPI = 35
kResourceType_Task = 36
kResourceType_Ultrasonic = 37
kResourceType_Victor = 38
kResourceType_Button = 39
kResourceType_Command = 40
kResourceType_AxisCamera = 41
kResourceType_PCVideoServer = 42
kResourceType_SmartDashboard = 43
kResourceType_Talon = 44
kResourceType_HiTechnicColorSensor = 45
kResourceType_HiTechnicAccel = 46
kResourceType_HiTechnicCompass = 47
kResourceType_SRF08 = 48
kResourceType_AnalogOutput = 49
kResourceType_VictorSP = 50
kResourceType_PWMTalonSRX = 51
kResourceType_CANTalonSRX = 52
kResourceType_ADXL362 = 53
kResourceType_ADXRS450 = 54
kResourceType_RevSPARK = 55
kResourceType_MindsensorsSD540 = 56
kResourceType_DigitalGlitchFilter = 57
kResourceType_ADIS16448 = 58
kResourceType_PDP = 59
kResourceType_PCM = 60
kResourceType_PigeonIMU = 61
kResourceType_NidecBrushless = 62
kResourceType_CANifier = 63
kResourceType_CTRE_future0 = 64
kResourceType_CTRE_future1 = 65
kResourceType_CTRE_future2 = 66
kResourceType_CTRE_future3 = 67
kResourceType_CTRE_future4 = 68
kResourceType_CTRE_future5 = 69
kResourceType_CTRE_future6 = 70
kResourceType_LinearFilter = 71
kResourceType_XboxController = 72
kResourceType_UsbCamera = 73
kResourceType_NavX = 74
kResourceType_Pixy = 75
kResourceType_Pixy2 = 76
kResourceType_ScanseSweep = 77
kResourceType_Shuffleboard = 78
kResourceType_CAN = 79
kResourceType_DigilentDMC60 = 80
kResourceType_PWMVictorSPX = 81
kResourceType_RevSparkMaxPWM = 82
kResourceType_RevSparkMaxCAN = 83
kResourceType_ADIS16470 = 84
kResourceType_Controller = 0
kResourceType_Module = 1
kResourceType_Language = 2
kResourceType_CANPlugin = 3
kResourceType_Accelerometer = 4
kResourceType_ADXL345 = 5
kResourceType_AnalogChannel = 6
kResourceType_AnalogTrigger = 7
kResourceType_AnalogTriggerOutput = 8
kResourceType_CANJaguar = 9
kResourceType_Compressor = 10
kResourceType_Counter = 11
kResourceType_Dashboard = 12
kResourceType_DigitalInput = 13
kResourceType_DigitalOutput = 14
kResourceType_DriverStationCIO = 15
kResourceType_DriverStationEIO = 16
kResourceType_DriverStationLCD = 17
kResourceType_Encoder = 18
kResourceType_GearTooth = 19
kResourceType_Gyro = 20
kResourceType_I2C = 21
kResourceType_Framework = 22
kResourceType_Jaguar = 23
kResourceType_Joystick = 24
kResourceType_Kinect = 25
kResourceType_KinectStick = 26
kResourceType_PIDController = 27
kResourceType_Preferences = 28
kResourceType_PWM = 29
kResourceType_Relay = 30
kResourceType_RobotDrive = 31
kResourceType_SerialPort = 32
kResourceType_Servo = 33
kResourceType_Solenoid = 34
kResourceType_SPI = 35
kResourceType_Task = 36
kResourceType_Ultrasonic = 37
kResourceType_Victor = 38
kResourceType_Button = 39
kResourceType_Command = 40
kResourceType_AxisCamera = 41
kResourceType_PCVideoServer = 42
kResourceType_SmartDashboard = 43
kResourceType_Talon = 44
kResourceType_HiTechnicColorSensor = 45
kResourceType_HiTechnicAccel = 46
kResourceType_HiTechnicCompass = 47
kResourceType_SRF08 = 48
kResourceType_AnalogOutput = 49
kResourceType_VictorSP = 50
kResourceType_PWMTalonSRX = 51
kResourceType_CANTalonSRX = 52
kResourceType_ADXL362 = 53
kResourceType_ADXRS450 = 54
kResourceType_RevSPARK = 55
kResourceType_MindsensorsSD540 = 56
kResourceType_DigitalGlitchFilter = 57
kResourceType_ADIS16448 = 58
kResourceType_PDP = 59
kResourceType_PCM = 60
kResourceType_PigeonIMU = 61
kResourceType_NidecBrushless = 62
kResourceType_CANifier = 63
kResourceType_CTRE_future0 = 64
kResourceType_CTRE_future1 = 65
kResourceType_CTRE_future2 = 66
kResourceType_CTRE_future3 = 67
kResourceType_CTRE_future4 = 68
kResourceType_CTRE_future5 = 69
kResourceType_CTRE_future6 = 70
kResourceType_LinearFilter = 71
kResourceType_XboxController = 72
kResourceType_UsbCamera = 73
kResourceType_NavX = 74
kResourceType_Pixy = 75
kResourceType_Pixy2 = 76
kResourceType_ScanseSweep = 77
kResourceType_Shuffleboard = 78
kResourceType_CAN = 79
kResourceType_DigilentDMC60 = 80
kResourceType_PWMVictorSPX = 81
kResourceType_RevSparkMaxPWM = 82
kResourceType_RevSparkMaxCAN = 83
kResourceType_ADIS16470 = 84

120
hal/src/main/native/include/hal/CANAPITypes.h
View File

@@ -1,60 +1,60 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2018-2019 FIRST. 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/Types.h"
/**
* @defgroup hal_canapi CAN API Functions
* @ingroup hal_capi
* @{
*/
// clang-format off
/**
* The CAN device type.
*
* Teams should use HAL_CAN_Dev_kMiscellaneous
*/
HAL_ENUM(HAL_CANDeviceType) {
HAL_CAN_Dev_kBroadcast = 0,
HAL_CAN_Dev_kRobotController = 1,
HAL_CAN_Dev_kMotorController = 2,
HAL_CAN_Dev_kRelayController = 3,
HAL_CAN_Dev_kGyroSensor = 4,
HAL_CAN_Dev_kAccelerometer = 5,
HAL_CAN_Dev_kUltrasonicSensor = 6,
HAL_CAN_Dev_kGearToothSensor = 7,
HAL_CAN_Dev_kPowerDistribution = 8,
HAL_CAN_Dev_kPneumatics = 9,
HAL_CAN_Dev_kMiscellaneous = 10,
HAL_CAN_Dev_kFirmwareUpdate = 31
};
/**
* The CAN manufacturer ID.
*
* Teams should use HAL_CAN_Man_kTeamUse.
*/
HAL_ENUM(HAL_CANManufacturer) {
HAL_CAN_Man_kBroadcast = 0,
HAL_CAN_Man_kNI = 1,
HAL_CAN_Man_kLM = 2,
HAL_CAN_Man_kDEKA = 3,
HAL_CAN_Man_kCTRE = 4,
HAL_CAN_Man_kREV = 5,
HAL_CAN_Man_kGrapple = 6,
HAL_CAN_Man_kMS = 7,
HAL_CAN_Man_kTeamUse = 8,
HAL_CAN_Man_kKauaiLabs = 9,
HAL_CAN_Man_kCopperforge = 10
};
// clang-format on
/** @} */
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2018-2019 FIRST. 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/Types.h"
/**
* @defgroup hal_canapi CAN API Functions
* @ingroup hal_capi
* @{
*/
// clang-format off
/**
* The CAN device type.
*
* Teams should use HAL_CAN_Dev_kMiscellaneous
*/
HAL_ENUM(HAL_CANDeviceType) {
HAL_CAN_Dev_kBroadcast = 0,
HAL_CAN_Dev_kRobotController = 1,
HAL_CAN_Dev_kMotorController = 2,
HAL_CAN_Dev_kRelayController = 3,
HAL_CAN_Dev_kGyroSensor = 4,
HAL_CAN_Dev_kAccelerometer = 5,
HAL_CAN_Dev_kUltrasonicSensor = 6,
HAL_CAN_Dev_kGearToothSensor = 7,
HAL_CAN_Dev_kPowerDistribution = 8,
HAL_CAN_Dev_kPneumatics = 9,
HAL_CAN_Dev_kMiscellaneous = 10,
HAL_CAN_Dev_kFirmwareUpdate = 31
};
/**
* The CAN manufacturer ID.
*
* Teams should use HAL_CAN_Man_kTeamUse.
*/
HAL_ENUM(HAL_CANManufacturer) {
HAL_CAN_Man_kBroadcast = 0,
HAL_CAN_Man_kNI = 1,
HAL_CAN_Man_kLM = 2,
HAL_CAN_Man_kDEKA = 3,
HAL_CAN_Man_kCTRE = 4,
HAL_CAN_Man_kREV = 5,
HAL_CAN_Man_kGrapple = 6,
HAL_CAN_Man_kMS = 7,
HAL_CAN_Man_kTeamUse = 8,
HAL_CAN_Man_kKauaiLabs = 9,
HAL_CAN_Man_kCopperforge = 10
};
// clang-format on
/** @} */

364
hal/src/main/native/include/hal/HALBase.h
View File

@@ -1,182 +1,182 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2008-2018 FIRST. 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/Types.h"
/**
* @defgroup hal_capi WPILib HAL API
* Hardware Abstraction Layer to hardware or simulator
* @{
*/
// clang-format off
HAL_ENUM(HAL_RuntimeType) { HAL_Athena, HAL_Mock };
// clang-format on
#ifdef __cplusplus
extern "C" {
#endif
/**
* Gets the error message for a specific status code.
*
* @param code the status code
* @return the error message for the code. This does not need to be freed.
*/
const char* HAL_GetErrorMessage(int32_t code);
/**
* Returns the FPGA Version number.
*
* For now, expect this to be competition year.
*
* @return FPGA Version number.
*/
int32_t HAL_GetFPGAVersion(int32_t* status);
/**
* Returns the FPGA Revision number.
*
* The format of the revision is 3 numbers.
* The 12 most significant bits are the Major Revision.
* the next 8 bits are the Minor Revision.
* The 12 least significant bits are the Build Number.
*
* @return FPGA Revision number.
*/
int64_t HAL_GetFPGARevision(int32_t* status);
HAL_RuntimeType HAL_GetRuntimeType(void);
/**
* Gets the state of the "USER" button on the roboRIO.
*
* @return true if the button is currently pressed down
*/
HAL_Bool HAL_GetFPGAButton(int32_t* status);
/**
* Gets if the system outputs are currently active
*
* @return true if the system outputs are active, false if disabled
*/
HAL_Bool HAL_GetSystemActive(int32_t* status);
/**
* Gets if the system is in a browned out state.
*
* @return true if the system is in a low voltage brown out, false otherwise
*/
HAL_Bool HAL_GetBrownedOut(int32_t* status);
/**
* The base HAL initialize function. Useful if you need to ensure the DS and
* base HAL functions (the ones above this declaration in HAL.h) are properly
* initialized. For normal programs and executables, please use HAL_Initialize.
*
* This is mainly expected to be use from libraries that are expected to be used
* from LabVIEW, as it handles its own initialization for objects.
*/
void HAL_BaseInitialize(int32_t* status);
#ifndef HAL_USE_LABVIEW
/**
* Gets a port handle for a specific channel.
*
* The created handle does not need to be freed.
*
* @param channel the channel number
* @return the created port
*/
HAL_PortHandle HAL_GetPort(int32_t channel);
/**
* Gets a port handle for a specific channel and module.
*
* This is expected to be used for PCMs, as the roboRIO does not work with
* modules anymore.
*
* The created handle does not need to be freed.
*
* @param module the module number
* @param channel the channel number
* @return the created port
*/
HAL_PortHandle HAL_GetPortWithModule(int32_t module, int32_t channel);
/**
* Reads the microsecond-resolution timer on the FPGA.
*
* @return The current time in microseconds according to the FPGA (since FPGA
* reset).
*/
uint64_t HAL_GetFPGATime(int32_t* status);
/**
* Call this to start up HAL. This is required for robot programs.
*
* This must be called before any other HAL functions. Failure to do so will
* result in undefined behavior, and likely segmentation faults. This means that
* any statically initialized variables in a program MUST call this function in
* their constructors if they want to use other HAL calls.
*
* The common parameters are 500 for timeout and 0 for mode.
*
* This function is safe to call from any thread, and as many times as you wish.
* It internally guards from any reentrancy.
*
* The applicable modes are:
* 0: Try to kill an existing HAL from another program, if not successful,
* error.
* 1: Force kill a HAL from another program.
* 2: Just warn if another hal exists and cannot be killed. Will likely result
* in undefined behavior.
*
* @param timeout the initialization timeout (ms)
* @param mode the initialization mode (see remarks)
* @return true if initialization was successful, otherwise false.
*/
HAL_Bool HAL_Initialize(int32_t timeout, int32_t mode);
// ifdef's definition is to allow for default parameters in C++.
#ifdef __cplusplus
/**
* Reports a hardware usage to the HAL.
*
* @param resource the used resource
* @param instanceNumber the instance of the resource
* @param context a user specified context index
* @param feature a user specified feature string
* @return the index of the added value in NetComm
*/
int64_t HAL_Report(int32_t resource, int32_t instanceNumber,
int32_t context = 0, const char* feature = nullptr);
#else
/**
* Reports a hardware usage to the HAL.
*
* @param resource the used resource
* @param instanceNumber the instance of the resource
* @param context a user specified context index
* @param feature a user specified feature string
* @return the index of the added value in NetComm
*/
int64_t HAL_Report(int32_t resource, int32_t instanceNumber, int32_t context,
const char* feature);
#endif
#endif // HAL_USE_LABVIEW
#ifdef __cplusplus
} // extern "C"
#endif
/** @} */
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2008-2019 FIRST. 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/Types.h"
/**
* @defgroup hal_capi WPILib HAL API
* Hardware Abstraction Layer to hardware or simulator
* @{
*/
// clang-format off
HAL_ENUM(HAL_RuntimeType) { HAL_Athena, HAL_Mock };
// clang-format on
#ifdef __cplusplus
extern "C" {
#endif
/**
* Gets the error message for a specific status code.
*
* @param code the status code
* @return the error message for the code. This does not need to be freed.
*/
const char* HAL_GetErrorMessage(int32_t code);
/**
* Returns the FPGA Version number.
*
* For now, expect this to be competition year.
*
* @return FPGA Version number.
*/
int32_t HAL_GetFPGAVersion(int32_t* status);
/**
* Returns the FPGA Revision number.
*
* The format of the revision is 3 numbers.
* The 12 most significant bits are the Major Revision.
* the next 8 bits are the Minor Revision.
* The 12 least significant bits are the Build Number.
*
* @return FPGA Revision number.
*/
int64_t HAL_GetFPGARevision(int32_t* status);
HAL_RuntimeType HAL_GetRuntimeType(void);
/**
* Gets the state of the "USER" button on the roboRIO.
*
* @return true if the button is currently pressed down
*/
HAL_Bool HAL_GetFPGAButton(int32_t* status);
/**
* Gets if the system outputs are currently active
*
* @return true if the system outputs are active, false if disabled
*/
HAL_Bool HAL_GetSystemActive(int32_t* status);
/**
* Gets if the system is in a browned out state.
*
* @return true if the system is in a low voltage brown out, false otherwise
*/
HAL_Bool HAL_GetBrownedOut(int32_t* status);
/**
* The base HAL initialize function. Useful if you need to ensure the DS and
* base HAL functions (the ones above this declaration in HAL.h) are properly
* initialized. For normal programs and executables, please use HAL_Initialize.
*
* This is mainly expected to be use from libraries that are expected to be used
* from LabVIEW, as it handles its own initialization for objects.
*/
void HAL_BaseInitialize(int32_t* status);
#ifndef HAL_USE_LABVIEW
/**
* Gets a port handle for a specific channel.
*
* The created handle does not need to be freed.
*
* @param channel the channel number
* @return the created port
*/
HAL_PortHandle HAL_GetPort(int32_t channel);
/**
* Gets a port handle for a specific channel and module.
*
* This is expected to be used for PCMs, as the roboRIO does not work with
* modules anymore.
*
* The created handle does not need to be freed.
*
* @param module the module number
* @param channel the channel number
* @return the created port
*/
HAL_PortHandle HAL_GetPortWithModule(int32_t module, int32_t channel);
/**
* Reads the microsecond-resolution timer on the FPGA.
*
* @return The current time in microseconds according to the FPGA (since FPGA
* reset).
*/
uint64_t HAL_GetFPGATime(int32_t* status);
/**
* Call this to start up HAL. This is required for robot programs.
*
* This must be called before any other HAL functions. Failure to do so will
* result in undefined behavior, and likely segmentation faults. This means that
* any statically initialized variables in a program MUST call this function in
* their constructors if they want to use other HAL calls.
*
* The common parameters are 500 for timeout and 0 for mode.
*
* This function is safe to call from any thread, and as many times as you wish.
* It internally guards from any reentrancy.
*
* The applicable modes are:
* 0: Try to kill an existing HAL from another program, if not successful,
* error.
* 1: Force kill a HAL from another program.
* 2: Just warn if another hal exists and cannot be killed. Will likely result
* in undefined behavior.
*
* @param timeout the initialization timeout (ms)
* @param mode the initialization mode (see remarks)
* @return true if initialization was successful, otherwise false.
*/
HAL_Bool HAL_Initialize(int32_t timeout, int32_t mode);
// ifdef's definition is to allow for default parameters in C++.
#ifdef __cplusplus
/**
* Reports a hardware usage to the HAL.
*
* @param resource the used resource
* @param instanceNumber the instance of the resource
* @param context a user specified context index
* @param feature a user specified feature string
* @return the index of the added value in NetComm
*/
int64_t HAL_Report(int32_t resource, int32_t instanceNumber,
int32_t context = 0, const char* feature = nullptr);
#else
/**
* Reports a hardware usage to the HAL.
*
* @param resource the used resource
* @param instanceNumber the instance of the resource
* @param context a user specified context index
* @param feature a user specified feature string
* @return the index of the added value in NetComm
*/
int64_t HAL_Report(int32_t resource, int32_t instanceNumber, int32_t context,
const char* feature);
#endif
#endif // HAL_USE_LABVIEW
#ifdef __cplusplus
} // extern "C"
#endif
/** @} */