Power.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  Power control access functions
 *
 *  Use the function GetPower() to get a handle to pass on to the other functions.
 *  Use the method Power_release(POWERHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include power_example.cpp
 *
 ************************************************/
#ifndef CC_POWER_H
#define CC_POWER_H
 
#include "CCAuxErrors.h"
#include "CCAuxTypes.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *POWERHANDLE;
 
EXTERN_C
CCAUXDLL_API
POWERHANDLE
CCAUXDLL_CALLING_CONV
GetPower(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV Power_release(POWERHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_getBLPowerStatus(POWERHANDLE, CCStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_getCanPowerStatus(POWERHANDLE, CCStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_getVideoPowerStatus(POWERHANDLE, uint8_t *videoStatus);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_getExtFanPowerStatus(POWERHANDLE, CCStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_getButtonPowerTransitionStatus(POWERHANDLE, ButtonPowerTransitionStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_getVideoOCDStatus(POWERHANDLE, OCDStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_getCanOCDStatus(POWERHANDLE, OCDStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_setBLPowerStatus(POWERHANDLE, CCStatus status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_setCanPowerStatus(POWERHANDLE, CCStatus status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_setVideoPowerStatus(POWERHANDLE, uint8_t status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_setExtFanPowerStatus(POWERHANDLE, CCStatus status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Power_ackPowerRequest(POWERHANDLE);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_POWER_H */