Files
MuditaOS/module-bluetooth/lib/Bluetopia/profiles/TPS/source/TPS.h

49 lines
3.1 KiB
C

/*****< tps.h >****************************************************************/
/* Copyright 2012 - 2014 Stonestreet One. */
/* All Rights Reserved. */
/* */
/* TPS - Bluetooth Stack Tx Power Service (GATT based) */
/* Type Definitions, Prototypes, and Constants. */
/* */
/* Author: Jay Wheeler */
/* */
/*** MODIFICATION HISTORY *****************************************************/
/* */
/* mm/dd/yy F. Lastname Description of Modification */
/* -------- ----------- ------------------------------------------------*/
/* 08/15/12 J. Wheeler Initial creation. */
/******************************************************************************/
#ifndef __TPSH__
#define __TPSH__
#include "BTTypes.h" /* Bluetooth type definitions/constants. */
/* The following function is responsible for making sure that the */
/* Bluetooth Stack TPS module is initialized correctly. This */
/* function *MUST* be called before ANY other Bluetooth Stack TPS */
/* function can be called. This function returns non-zero if the */
/* module was initialized correctly, or a zero value if there was an */
/* error. */
/* * NOTE * Internally, this module will make sure that this function*/
/* has been called at least once so that the module will */
/* function. Calling this function from an external */
/* location is not necessary. */
int InitializeTPSModule(void);
/* The following function is responsible for instructing the */
/* Bluetooth Stack TPS Module to clean up any resources that it has */
/* allocated. Once this function has completed, NO other Bluetooth */
/* Stack TPS functions can be called until a successful call to the */
/* InitializeTPSModule() function is made. The parameter to this */
/* function specifies the context in which this function is being */
/* called. If the specified parameter is TRUE, then the module will */
/* make sure that NO functions that would require waiting/blocking on*/
/* Mutexes/Events are called. This parameter would be set to TRUE if*/
/* this function was called in a context where threads would not be */
/* allowed to run. If this function is called in the context where */
/* threads are allowed to run then this parameter should be set to */
/* FALSE. */
void CleanupTPSModule(Boolean_t ForceCleanup);
#endif