btstack/src/btstack_control.h
2021-11-02 09:31:00 +01:00

78 lines
2.7 KiB
C

/*
* Copyright (C) 2014 BlueKitchen GmbH
*
* 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 holders nor the names of
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
* 4. Any redistribution, use, or modification is done solely for
* personal benefit and not for any commercial purpose or for
* monetary gain.
*
* THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH 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 BLUEKITCHEN
* GMBH 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.
*
* Please inquire about commercial licensing options at
* contact@bluekitchen-gmbh.com
*
*/
/**
* @title Bluetooth Power Control
*
* The Bluetooth Hardware Control API allows HCI to manage Bluetooth chipsets via direct hardware controls.
*
*/
#ifndef BTSTACK_CONTROL_H
#define BTSTACK_CONTROL_H
#include <stdint.h>
#include "btstack_util.h"
#if defined __cplusplus
extern "C" {
#endif
typedef enum {
POWER_WILL_SLEEP = 1,
POWER_WILL_WAKE_UP
} POWER_NOTIFICATION_t;
/* API_START */
typedef struct {
void (*init) (const void *config);
int (*on) (void); // <-- turn BT module on and configure
int (*off) (void); // <-- turn BT module off
int (*sleep)(void); // <-- put BT module to sleep - only to be called after ON
int (*wake) (void); // <-- wake BT module from sleep - only to be called after SLEEP
void (*register_for_power_notifications)(void (*cb)(POWER_NOTIFICATION_t event));
} btstack_control_t;
/* API_END */
#if defined __cplusplus
}
#endif
#endif // BTSTACK_CONTROL_H