cascoda_btn.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2023, Cascoda Ltd.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
/*
 * Button / LED Functions for Cascoda UI
*/
 
#ifndef CASCODA_BTN_H
#define CASCODA_BTN_H
 
#include "cascoda-bm/cascoda_types.h"
#include "ca821x_api.h"
#include "ca821x_error.h"
 
/* max. number of LED/Button pairs on board */
#define NUM_LEDBTN 4
 
/* minimum press time for additional de-bouncing in [ms] */
#define BTN_MIN_PRESS_TIME 5
 
#ifndef BTN_SHARED_SENSE_DELAY
#define BTN_SHARED_SENSE_DELAY 2
#endif
 
/* Execute short press callback when pressed or on release
 * Note: BTN_SHORTPRESS_RELEASED should only be used when
 * the same button is being registered with a long press
 * callback.
 */
enum btn_shortpress_mode
{
    BTN_SHORTPRESS_PRESSED  = 0,
    BTN_SHORTPRESS_RELEASED = 1
};
 
/* Button state */
enum btn_button_state
{
    BTN_PRESSED  = 0,
    BTN_RELEASED = 1
};
 
/* pin types */
enum btn_pin_type
{
    PINTYPE_NONE   = 0,
    PINTYPE_LED    = 1,
    PINTYPE_BTN    = 2,
    PINTYPE_SHARED = 3,
};
 
/* Whether an interrupt is registered for the pin or not */
enum btn_pin_int
{
    PIN_NO_INTERRUPT = 0,
    PIN_INTERRUPT    = 1,
};
 
/* dvbd callback type definition */
typedef void (*btn_callback)(void* context);
 
typedef struct btn_callback_info
{
    btn_callback shortPressCallback; 
    void*        shortPressContext;  
    btn_callback longPressCallback; 
    void*        longPressContext;  
    btn_callback holdCallback; 
    void*        holdContext;  
    uint32_t currentPressTime;       
    uint32_t longPressTimeThreshold; 
    uint32_t holdTimeInterval;       
    uint32_t holdTimeLast;           
    uint8_t  lastState;              
    uint8_t  shortPressMode;         
} btn_callback_info;
 
/* Map from Button declaration to actual module pin number */
extern uint8_t registeredPinMappings[];
 
/* functions */
 
ca_error Btn_RegisterLEDOutput(uint8_t ledBtn);
 
ca_error Btn_RegisterButtonInput(uint8_t ledBtn);
 
ca_error Btn_RegisterButtonIRQInput(uint8_t ledBtn);
 
ca_error Btn_RegisterSharedButtonLED(uint8_t ledBtn);
 
ca_error Btn_RegisterSharedIRQButtonLED(uint8_t ledBtn);
 
ca_error Btn_DeRegister(uint8_t ledBtn);
 
ca_error Btn_SetButtonShortPressCallback(uint8_t ledBtn, btn_callback callback, void* context, uint8_t shortPressMode);
 
ca_error Btn_SetButtonLongPressCallback(uint8_t ledBtn, btn_callback callback, void* context, uint32_t timeThreshold);
 
ca_error Btn_SetButtonHoldCallback(uint8_t ledBtn, btn_callback callback, void* context, uint32_t TimeInterval);
 
ca_error Btn_SetLED(uint8_t ledBtn, uint8_t val);
 
ca_error Btn_Sense(uint8_t ledBtn, uint8_t* val);
 
ca_error Btn_SenseOutput(uint8_t ledBtn, uint8_t* val);
 
ca_error Btn_PollButtons(void);
 
ca_error Btn_HandleButtonCallbacks(btn_callback_info* callback, uint8_t pressed);
 
void Btn_IncrementGPIOWakeup(void);
 
ca_error Btn_DecrementGPIOWakeup(void);
 
void Btn_SetSleepPermanently(void);
 
bool Btn_CanSleep(void);
 
ca_error Btn_DevboardSleep(uint32_t aSleepTime, struct ca821x_dev* pDeviceRef);
 
#endif // CASCODA_BTN_H