mirror/MuditaOS
1
0
Fork 0
mirror of https://github.com/mudita/MuditaOS.git synced 2026-07-04 05:06:58 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
f7c8af86c858cd03142f62d582ef6461ba2168db
MuditaOS/module-bluetooth/lib/Bluetopia/include/HCICommT.h

465 lines
31 KiB
C
Raw Blame History

/*****< hcicommt.h >***********************************************************/
/* Copyright 2000 - 2014 Stonestreet One. */
/* All Rights Reserved. */
/* */
/* HCICOMMT - Serial HCI Driver Layer Types. */
/* */
/* Author: Tim Thomas */
/* */
/*** MODIFICATION HISTORY *****************************************************/
/* */
/* mm/dd/yy F. Lastname Description of Modification */
/* -------- ----------- ------------------------------------------------*/
/* 07/25/00 T. Thomas Initial creation. */
/******************************************************************************/
#ifndef __HCICOMMTH__
#define __HCICOMMTH__
#include "BTAPITyp.h" /* Bluetooth API Type Definitions. */
#include "BTTypes.h" /* Bluetooth Type Definitions/Constants. */
/* The following constants represent the Minimum, Maximum, and */
/* Values that are used with the Initialization Delay member of the */
/* HCI_COMMDriverInformation_t structure. These Delays are specified*/
/* in Milliseconds and represent the delay that is to be added */
/* between Port Initialization (Open) and the writing of any data to */
/* the Port. This functionality was added because it was found that */
/* some PCMCIA/Compact Flash Cards required a delay between the */
/* time the Port was opened and the time when the Card was ready to */
/* accept data. The default is NO Delay (0 Milliseconds). */
#define HCI_COMM_INFORMATION_INITIALIZATION_DELAY_MINIMUM 0
#define HCI_COMM_INFORMATION_INITIALIZATION_DELAY_MAXIMUM 5000
#define HCI_COMM_INFORMATION_INITIALIZATION_DELAY_DEFAULT 0
/* The following type declaration defines the HCI Serial Protocol */
/* that will be used as the physical HCI Transport Protocol on the */
/* actual COM Port that is opened. This type declaration is used in */
/* the HCI_COMMDriverInformation_t structure that is required when */
/* an HCI COMM Port is opened. */
typedef enum
{
cpUART,
cpUART_RTS_CTS,
cpBCSP,
cpBCSP_Muzzled,
cpH4DS,
cpH4DS_RTS_CTS,
cpHCILL,
cpHCILL_RTS_CTS,
cp3Wire,
cp3Wire_RTS_CTS,
cpSIBS,
cpSIBS_RTS_CTS
} HCI_COMM_Protocol_t;
typedef enum
{
hcpNoParity,
hcpEvenParity
} HCI_COMM_Parity_t;
/* The following prototype is for a callback function to handle */
/* changes in the sleep state of the COMM layer. The first parameter*/
/* indicates if sleep is allowed. If this parameter is true, the */
/* application can safely power-down the associated hardware. If */
/* this parameter is false, the application should ensure that the */
/* hardware is in a state that allows for normal communication. */
/* * NOTE * If the COM port is put to sleep, the application is */
/* responsible for reactivating the port when data is */
/* received or when needs to be sent. */
/* * NOTE * The callback function should not make any direct calls */
/* into the Bluetooth stack. */
/* * NOTE * This function can be called in the context of any thread */
/* that calls a stack API or the HCITRANS COM Data Callback */
/* function. No locks should be aquired within this */
/* function that could also be held by another thread */
/* accessing the stack or a thread lock may occur. */
typedef void (BTPSAPI *HCI_Sleep_Callback_t)(Boolean_t SleepAllowed, unsigned long CallbackParameter);
/* The following type declaration represents the structure of all */
/* Data that is needed to open an HCI COMM Port. */
typedef struct _tagHCI_COMMDriverInformation_t
{
unsigned int DriverInformationSize; /* Physical Size of this */
/* structure. */
unsigned int COMPortNumber; /* Physical COM Port Number */
/* of the Physical COM Port to*/
/* Open. */
unsigned long BaudRate; /* Baud Rate to Open COM Port.*/
HCI_COMM_Protocol_t Protocol; /* HCI Protocol that will be */
/* used for communication over*/
/* Opened COM Port. */
unsigned int InitializationDelay; /* Time (In Milliseconds) to */
/* Delay after the Port is */
/* opened before any data is */
/* sent over the Port. This */
/* member is present because */
/* some PCMCIA/Compact Flash */
/* Cards have been seen that */
/* require a delay because the*/
/* card does not function for */
/* some specified period of */
/* time. */
char *COMDeviceName; /* Physical Device Name to use*/
/* to override the device to */
/* open. If COMPortNumber is */
/* specified to be the */
/* equivalent of negative 1 */
/* (-1), then this value is */
/* taken as an absolute name */
/* and the COM Port Number is */
/* NOT appended to this value.*/
/* If this value is NULL then */
/* the default (compiled) COM */
/* Device Name is used (and */
/* the COM Port Number is */
/* appended to the default). */
unsigned int Flags; /* Flags for additional port */
/* information. See */
/* definitions below for */
/* contents. */
} HCI_COMMDriverInformation_t;
/* The following define the bit mask values of the flags member of */
/* the HCI_COMMDriverInformation_t structure. */
#define HCI_COMM_DRIVER_INFORMATION_FLAGS_USE_EVEN_PARITY_FLAG 0x0001
#define HCI_COMM_DRIVER_INFORMATION_FLAGS_SHARED_TRANSPORT 0x0002
/* The following type declaration represents the settings that can be*/
/* changed for an already open HCI COM port. */
typedef struct _tagHCI_COMMReconfigureInformation_t
{
unsigned int ReconfigureFlags; /* Flags to indicate what */
/* aspects of the COMM port */
/* are to be reconfigured. */
HCI_COMM_Protocol_t Protocol; /* Specifies the protocol to */
/* be used for the COMM port. */
/* This value is ignored if */
/* the Change Protocol flag is*/
/* not set. */
unsigned long BaudRate; /* Specifies the baudrate to */
/* be used for the COMM port. */
/* This value is ignored if */
/* the Change BaudRate flag is*/
/* not set. */
Boolean_t UseXonXoff; /* Specifies if Xon/Xoff flow */
/* control should be used for */
/* the COMM port. This value */
/* is ignored if the Change */
/* Xon/Xoff flag is not set. */
unsigned char XonValue; /* Specifies The Xon and Xoff */
/* values to be used for the */
/* COMM port. This value is */
/* ignored if the Change */
/* Xon/Xoff flag is not set or*/
/* the Use Xon/Xoff flag is */
/* FALSE. */
unsigned char XoffValue; /* Specifies The Xon and Xoff */
/* values to be used for the */
/* COMM port. This value is */
/* ignored if the Change */
/* Xon/Xoff flag is not set or*/
/* the Use Xon/Xoff flag is */
/* FALSE. */
HCI_COMM_Parity_t ParityValue; /* Specifies the parity that */
/* should be used if the */
/* protocol in use allows */
/* different options. Zero */
/* specifies no parity, or one*/
/* for even parity. This */
/* valus is ignored if the */
/* Change parity flag is not */
/* set or the setting is not */
/* supported by the protocol */
/* in use. */
} HCI_COMMReconfigureInformation_t;
/* The following constants represent the bit mask of values for the */
/* ReconfigureFlags member of the HCI_COMM_ReconfigureInformation_t */
/* structure to indicate what parameters should be updated. If a bit*/
/* is set, its parameters will be updated. */
#define HCI_COMM_RECONFIGURE_INFORMATION_RECONFIGURE_FLAGS_CHANGE_PROTOCOL 0x0001
#define HCI_COMM_RECONFIGURE_INFORMATION_RECONFIGURE_FLAGS_CHANGE_BAUDRATE 0x0002
#define HCI_COMM_RECONFIGURE_INFORMATION_RECONFIGURE_FLAGS_CHANGE_XON_XOFF 0x0004
#define HCI_COMM_RECONFIGURE_INFORMATION_RECONFIGURE_FLAGS_CHANGE_PARITY 0x0008
/* The following structure defines the application configurable */
/* settings for an H4DS instance. */
/* * NOTE * For all parameters except the SleepCallbackFunction and */
/* SleepCallbackParameter, a value of 0 will keep the */
/* current setting. */
typedef struct _tagHCI_H4DSConfiguration_t
{
unsigned int SyncTimeMS; /* The time between successive*/
/* sync messages being sent. */
unsigned int ConfTimeMS; /* The time between successive*/
/* conf messages being sent. */
unsigned int WakeUpTimeMS; /* The time between successive*/
/* wake-up messages being */
/* sent. */
unsigned int IdleTimeMS; /* The time of inactivity */
/* before the link is */
/* considered idle. */
unsigned int MaxTxFlushTimeMS; /* The time to wait for the */
/* transmit buffer to be */
/* flushed before the */
/* connection can be put to */
/* sleep. */
unsigned int WakeUpCount; /* The number of wake-up */
/* messages that will be sent */
/* before the peer is assumed */
/* idle. */
unsigned int TicksPerWakueUp; /* The number of ticks that */
/* will be sent before every */
/* wake-up message. */
HCI_Sleep_Callback_t SleepCallbackFunction; /* Provides the function to be*/
/* used for sleep callback */
/* indications. A NULL value */
/* will disable callbacks. */
unsigned long SleepCallbackParameter; /* The Parameter to be passed */
/* with the callback function.*/
/* This value is ignored if */
/* the SleepCallbackFunction */
/* specified is NULL. */
} HCI_H4DSConfiguration_t;
/* The following structure defines the application configurable */
/* settings for an HCILL instance. */
typedef struct _tagHCI_HCILLConfiguration_t
{
HCI_Sleep_Callback_t SleepCallbackFunction; /* Provides the function to be*/
/* used for sleep callback */
/* indications. A NULL value */
/* will disable callbacks. */
unsigned long SleepCallbackParameter; /* The Parameter to be passed */
/* with the callback function.*/
/* This value is ignored if */
/* the SleepCallbackFunction */
/* specified is NULL. */
} HCI_HCILLConfiguration_t;
/* The following struct contains the configuration for the link of */
/* the 3-Wire interface. These parameters will only be applied */
/* during the link negotiation with the baseband that takes place */
/* when the first is sent or when the 3-wire state machines are reset*/
/* via the HCI_Reconfigure_Driver() function. */
/* * NOTE * That resetting the state machines will result is any */
/* currently queued packets being lost so should only be */
/* done when the interface is idle, usually during initial */
/* setup. */
typedef struct _tagHCI_3WireLinkConfiguration_t
{
unsigned int SlidingWindowSize; /* The maximum size of the */
/* 3-wire sliding window in */
/* packets. */
Boolean_t SupportCRC; /* Denotes if a CRC Data */
/* Integrity Check is */
/* supported. */
Boolean_t SupportOOFFlowControl; /* Denotes if a OOF Flow */
/* Control (Xon/Xoff) is */
/* supported. */
} HCI_3WireLinkConfiguration_t;
/* The following structure defines the application configuration */
/* settings for the Three Wire UART interface. */
/* * NOTE * For all parameters except the SleepCallbackFunction, */
/* SleepCallbackParameter, LinkConfiguration, and Flags, a */
/* value of zero will keep the current setting. The */
/* LinkConfiguration will keep its current settings if the */
/* SlidingWindowSize is set to zero. */
typedef struct _tagHCI_3WireConfiguration_t
{
HCI_3WireLinkConfiguration_t LinkConfiguration; /* The link configuration */
/* to use. If the Sliding */
/* Window size is 0, then the */
/* settings in this structure */
/* are ignored. Additionally, */
/* these settings will not */
/* have an affect unless the */
/* 3-Wire state machines are */
/* restarted. */
unsigned int IdleTimeMS; /* The time of inactivity */
/* before the link is */
/* considered idle and put to */
/* sleep. */
unsigned int RetransmitTimeMS; /* The time between packet */
/* retransmissions. */
unsigned int AcknowledgeDelayMS; /* The maximum time to */
/* delay before acknowledging */
/* a received packet. */
HCI_Sleep_Callback_t SleepCallbackFunction; /* Provides the */
/* function to be used for */
/* sleep callback indications.*/
/* A NULL value will disable */
/* callbacks. */
unsigned long SleepCallbackParameter; /* The Parameter to */
/* be passed with the callback*/
/* function. This value is */
/* ignored if the */
/* SleepCallbackFunction */
/* specified is NULL. */
unsigned int Flags; /* Miscellaneous configuration*/
/* flags for 3-wire Interface.*/
} HCI_3WireConfiguration_t;
/* The following constants represent the bit mask of values for the */
/* Flags member of the HCI_3WireConfiguration_t. */
#define HCI_3WIRE_CONFIGURATION_FLAGS_SCO_IS_RELIABLE 0x0001
/* The following structure defines the application configurable */
/* settings for an SIBS instance. */
typedef struct _tagHCI_SIBSConfiguration_t
{
unsigned int TxIdleTimeMs; /* The time of inactivity */
/* before the transmit link is*/
/* considered idle and put to */
/* sleep. */
unsigned int RetransmitTimeMs; /* The time between message */
/* retransmissions. */
Boolean_t AggressiveSleep; /* This flag indicates */
/* that the SIBS instance */
/* should use Aggressive Sleep*/
/* mode. In this mode, the */
/* transmit link is put to */
/* sleep after the packet */
/* queue is emptied instead of*/
/* waiting for the idle timer */
/* to expire. */
HCI_Sleep_Callback_t SleepCallbackFunction; /* Provides the function to be*/
/* used for sleep callback */
/* indications. A NULL value */
/* will disable callbacks. */
unsigned long SleepCallbackParameter; /* The Parameter to be passed */
/* with the callback function.*/
/* This value is ignored if */
/* the SleepCallbackFunction */
/* specified is NULL. */
} HCI_SIBSConfiguration_t;
/* The following constant is used with the */
/* HCI_Driver_Reconfigure_Data_t structure (ReconfigureCommand */
/* member) to specify that the H4DS parameters are required to */
/* change. When specified, the ReconfigureData member will point to */
/* a valid HCI_H4DSConfigureation_t structure which holds the new */
/* parameters. */
/* * NOTE * HCI_ReconfigureDriver will return 1 if the connection is */
/* currently asleep, 0 if it is not asleep or a negative */
/* value if there is an error fore this command. */
#define HCI_COMM_DRIVER_RECONFIGURE_DATA_COMMAND_CHANGE_H4DS_PARAMETERS (HCI_DRIVER_RECONFIGURE_DATA_RECONFIGURE_COMMAND_TRANSPORT_START)
/* The following constant is used with the */
/* HCI_Driver_Reconfigure_Data_t structure (ReconfigureCommand */
/* member) to specify that the HCILL parameters are required to */
/* change. When specified, the ReconfigureData member will point to */
/* a valid HCI_HCILLConfigureation_t structure which holds the new */
/* parameters. */
/* * NOTE * HCI_ReconfigureDriver will return 1 if the connection is */
/* currently asleep, 0 if it is not asleep or a negative */
/* value if there is an error fore this command. */
#define HCI_COMM_DRIVER_RECONFIGURE_DATA_COMMAND_CHANGE_HCILL_PARAMETERS (HCI_DRIVER_RECONFIGURE_DATA_RECONFIGURE_COMMAND_TRANSPORT_START + 1)
/* The following constant is used with the */
/* HCI_Driver_Reconfigure_Data_t structure (ReconfigureCommand */
/* member) to specify that the Three Wire UART parameters are */
/* required to change. When specified, the ReconfigureData member */
/* will point to a valid HCI_3WireConfigureation_t structure which */
/* holds the protocol parameters. */
/* * NOTE * HCI_ReconfigureDriver will return 1 if the connection is */
/* currently asleep, 0 if it is not asleep or a negative */
/* value if there is an error fore this command. */
#define HCI_COMM_DRIVER_RECONFIGURE_DATA_COMMAND_CHANGE_3WIRE_PARAMETERS (HCI_DRIVER_RECONFIGURE_DATA_RECONFIGURE_COMMAND_TRANSPORT_START + 2)
/* The following constant is used with the */
/* HCI_Driver_Reconfigure_Data_t structure (ReconfigureCommand */
/* member) to specify reconfiguring of the port parameters. When */
/* specified, the ReconfigureData member will point to a valid */
/* _tagHCI_COMMReconfigureInformation_t structure which holds the */
/* information for the parameters to be changed. */
#define HCI_COMM_DRIVER_RECONFIGURE_DATA_COMMAND_CHANGE_COMM_PARAMETERS (HCI_DRIVER_RECONFIGURE_DATA_RECONFIGURE_COMMAND_TRANSPORT_START + 3)
/* The following constant is used with the */
/* HCI_Driver_Reconfigure_Data_t structure (ReconfigureCommand */
/* member) to specify that the SIBS parameters are required to */
/* change. When specified, the ReconfigureData member will point to */
/* a valid HCI_SIBSConfigureation_t structure which holds the new */
/* parameters. */
/* * NOTE * HCI_ReconfigureDriver will return 1 if the connection is */
/* currently asleep, 0 if it is not asleep or a negative */
/* value if there is an error fore this command. */
#define HCI_COMM_DRIVER_RECONFIGURE_DATA_COMMAND_CHANGE_SIBS_PARAMETERS (HCI_DRIVER_RECONFIGURE_DATA_RECONFIGURE_COMMAND_TRANSPORT_START + 4)
/* The following constants represent the Minimum and Maximum time in */
/* milliseconds before the H4DS layer considers the port to be idle. */
#define HCI_H4DS_MINIMUM_IDLE_TIME BTPS_CONFIGURATION_TIMER_MINIMUM_TIMER_RESOLUTION_MS
#define HCI_H4DS_MAXIMUM_IDLE_TIME 30000
/* The following constants represent the Minimum and Maximum time in */
/* milliseconds between wake-up messages being sent by the H4DS */
/* layer. */
#define HCI_H4DS_MINIMUM_WAKE_UP_MESSAGE_TIME BTPS_CONFIGURATION_TIMER_MINIMUM_TIMER_RESOLUTION_MS
#define HCI_H4DS_MAXIMUM_WAKE_UP_MESSAGE_TIME 1000
/* The following constants represent the Minimum and Maximum number */
/* of ticks sent before each wake-up message by the H4DS layer. */
#define HCI_H4DS_MINIMUM_TICKS_PER_WAKE_UP 1
#define HCI_H4DS_MAXIMUM_TICKS_PER_WAKE_UP 50
/* The following constants represent the Minimum and Maximum number */
/* of Wake-up messages sent by the H4DS layer before the peer is */
/* considered idle. */
#define HCI_H4DS_MINIMUM_WAKE_UP_MESSAGE_COUNT 1
#define HCI_H4DS_MAXIMUM_WAKE_UP_MESSAGE_COUNT 100
/* The following constants represent the Minimum and Maximum time in */
/* milliseconds that the H4DS layer waits for the transmit buffers to*/
/* be flushed before transitioning to a state where sleep is allowed.*/
#define HCI_H4DS_MINIMUM_TRANSMIT_FLUSH_TIME BTPS_CONFIGURATION_TIMER_MINIMUM_TIMER_RESOLUTION_MS
#define HCI_H4DS_MAXIMUM_TRANSMIT_FLUSH_TIME 30000
/* The following constants represent the Minimum and Maximum time in */
/* milliseconds between SYNC messages being sent by the H4DS layer. */
#define HCI_H4DS_MINIMUM_SYNC_MESSAGE_TIME BTPS_CONFIGURATION_TIMER_MINIMUM_TIMER_RESOLUTION_MS
#define HCI_H4DS_MAXIMUM_SYNC_MESSAGE_TIME 1000
/* The following constants represent the Minimum and Maximum time in */
/* milliseconds between CONF messages being sent by the H4DS layer. */
#define HCI_H4DS_MINIMUM_CONF_MESSAGE_TIME BTPS_CONFIGURATION_TIMER_MINIMUM_TIMER_RESOLUTION_MS
#define HCI_H4DS_MAXIMUM_CONF_MESSAGE_TIME 1000
/* The following constants represent the Minimum and Maximum values */
/* in packets that can be used for the 3-Wire sliding window size. */
#define HCI_3WIRE_MINIMUM_SLIDING_WINDOW_SIZE 1
#define HCI_3WIRE_MAXIMUM_SLIDING_WINDOW_SIZE 7
/* The following constants represent the Minimum and Maximum time in */
/* milliseconds before the Three Wire UART layer considers the port */
/* to be idle. */
#define HCI_3WIRE_MINIMUM_IDLE_TIME BTPS_CONFIGURATION_TIMER_MINIMUM_TIMER_RESOLUTION_MS
#define HCI_3WIRE_MAXIMUM_IDLE_TIME 30000
/* The following constants represent the Minimum and Maximum time in */
/* milliseconds before the Three Wire UART layer will retransmit a */
/* packet. */
#define HCI_3WIRE_MINIMUM_RETRANSMIT_TIME BTPS_CONFIGURATION_TIMER_MINIMUM_TIMER_RESOLUTION_MS
#define HCI_3WIRE_MAXIMUM_RETRANSMIT_TIME 1000
/* The following constants represent the Minimum and Maximum time in */
/* milliseconds before the Three Wire UART layer to wait before */
/* acknowledging a received packet. */
#define HCI_3WIRE_MINIMUM_ACKNOWLEDGE_DELAY BTPS_CONFIGURATION_TIMER_MINIMUM_TIMER_RESOLUTION_MS
#define HCI_3WIRE_MAXIMUM_ACKNOWLEDGE_DELAY 500
/* The following constants represent the Minimum and Maximum time in */
/* milliseconds before the QCA In-Band Sleep protocol considers the */
/* port to be idle. */
#define HCI_SIBS_MINIMUM_TX_IDLE_TIME 10
#define HCI_SIBS_MAXIMUM_TX_IDLE_TIME 30000
/* The following constants represent the Minimum and Maximum time in */
/* milliseconds between message retransmission in the QCA In-Band */
/* Sleep protocol. */
#define HCI_SIBS_MINIMUM_RETRANSMIT_TIME 10
#define HCI_SIBS_MAXIMUM_RETRANSMIT_TIME 1000
#endif
Reference in New Issue View Git Blame Copy Permalink