mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-29 02:21:44 +00:00
c3908660b1
As discussed, we don't really need the error checking specifically, as we are just going to throw exceptions anyway, so this will make sure you can check for 0 and be sure you catch any handle errors.
72 lines
2.4 KiB
C++
72 lines
2.4 KiB
C++
/*----------------------------------------------------------------------------*/
|
|
/* 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/Handles.h"
|
|
|
|
/* General Handle Data Layout
|
|
* Bits 0-15: Handle Index
|
|
* Bits 16-23: Unused
|
|
* Bits 24-30: Handle Type
|
|
* Bit 31: 1 if handle error, 0 if no error
|
|
*
|
|
* Other specialized handles will use different formats, however Bits 24-31 are
|
|
* always reserved for type and error handling.
|
|
*/
|
|
|
|
namespace hal {
|
|
|
|
constexpr int16_t InvalidHandleIndex = -1;
|
|
|
|
enum class HalHandleEnum { Undefined = 0, DIO = 1, Port = 2, Notifier = 3 };
|
|
|
|
static inline int16_t getHandleIndex(HalHandle handle) {
|
|
// mask and return last 16 bits
|
|
return (int16_t)(handle & 0xffff);
|
|
}
|
|
static inline HalHandleEnum getHandleType(HalHandle handle) {
|
|
// mask first 8 bits and cast to enum
|
|
return (HalHandleEnum)((handle >> 24) & 0xff);
|
|
}
|
|
static inline bool isHandleType(HalHandle handle, HalHandleEnum handleType) {
|
|
return handleType == getHandleType(handle);
|
|
}
|
|
static inline int16_t getHandleTypedIndex(HalHandle handle,
|
|
HalHandleEnum enumType) {
|
|
if (!isHandleType(handle, enumType)) return InvalidHandleIndex;
|
|
return getHandleIndex(handle);
|
|
}
|
|
|
|
/* specialized functions for Port handle
|
|
* Port Handle Data Layout
|
|
* Bits 0-7: Pin Number
|
|
* Bits 8-15: Module Number
|
|
* Bits 16-23: Unused
|
|
* Bits 24-30: Handle Type
|
|
* Bit 31: 1 if handle error, 0 if no error
|
|
*/
|
|
|
|
// using a 16 bit value so we can store 0-255 and still report error
|
|
static inline int16_t getPortHandlePin(HalPortHandle handle) {
|
|
if (!isHandleType(handle, HalHandleEnum::Port)) return InvalidHandleIndex;
|
|
return (uint8_t)(handle & 0xff);
|
|
}
|
|
|
|
// using a 16 bit value so we can store 0-255 and still report error
|
|
static inline int16_t getPortHandleModule(HalPortHandle handle) {
|
|
if (!isHandleType(handle, HalHandleEnum::Port)) return InvalidHandleIndex;
|
|
return (uint8_t)((handle >> 8) & 0xff);
|
|
}
|
|
|
|
HalPortHandle createPortHandle(uint8_t pin, uint8_t module);
|
|
|
|
HalHandle createHandle(int16_t index, HalHandleEnum handleType);
|
|
}
|