Infineon Logo AIROC BTSDK v4.4 - Documentation
 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
wiced_external_pa.h File Reference

> More...

Macros

#define WICED_GPIO_NOT_USED   MAX_NUM_OF_GPIO
 

Enumerations

enum  wiced_hal_epa_mode_t {
  EPA_MODE_OFF, EPA_MODE_NORMAL, EPA_MODE_WITH_CSD, EPA_MODE_RX_ONLY,
  EPA_MODE_A2DP_ONLY, EPA_MODE_A2DP_ONLY_WITH_BYP
}
 

Functions

wiced_result_t wiced_external_pa_configure (wiced_bt_gpio_numbers_t ctx_pin, wiced_bt_gpio_numbers_t crx_pin, wiced_bt_gpio_numbers_t csd_byp_pin, wiced_hal_epa_mode_t epa_mode)
 Normally the Front End Module (FEM) control signals would be defined in the platform_gpio_pins structure and the corresponding functions (WICED_EPA_CTX, WICED_EPA_CRX, and WICED_EPA_CSD) and are always enabled. More...
 

Detailed Description

>

Provides the API definitions for the External PA interface driver.

This software, including source code, documentation and related materials ("Software") is owned by Cypress Semiconductor Corporation or one of its affiliates ("Cypress") and is protected by and subject to worldwide patent protection (United States and foreign), United States copyright laws and international treaty provisions. Therefore, you may use this Software only as provided in the license agreement accompanying the software package from which you obtained this Software ("EULA"). If no EULA applies, Cypress hereby grants you a personal, non-exclusive, non-transferable license to copy, modify, and compile the Software source code solely for use in connection with Cypress's integrated circuit products. Any reproduction, modification, translation, compilation, or representation of this Software except as specified above is prohibited without the express written permission of Cypress.

Disclaimer: THIS SOFTWARE IS PROVIDED AS-IS, WITH NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, NONINFRINGEMENT, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress reserves the right to make changes to the Software without notice. Cypress does not assume any liability arising out of the application or use of the Software or any product or circuit described in the Software. Cypress does not authorize its products for use in any products where a malfunction or failure of the Cypress product may reasonably be expected to result in significant property damage, injury or death ("High Risk Product"). By including Cypress's product in a High Risk Product, the manufacturer of such system or application assumes all risk of such use and in doing so agrees to indemnify Cypress against all liability.

Function Documentation

wiced_result_t wiced_external_pa_configure ( wiced_bt_gpio_numbers_t  ctx_pin,
wiced_bt_gpio_numbers_t  crx_pin,
wiced_bt_gpio_numbers_t  csd_byp_pin,
wiced_hal_epa_mode_t  epa_mode 
)

Normally the Front End Module (FEM) control signals would be defined in the platform_gpio_pins structure and the corresponding functions (WICED_EPA_CTX, WICED_EPA_CRX, and WICED_EPA_CSD) and are always enabled.

The wiced_external_pa library provides application developers more dynamic control of the FEM control signals. The wiced_external_pa_configure api configures, enables, disables external power amplifier control logic signals CTX, CRX(if used), and CSD/BYP(if used). See wiced_hal_epa_mode_t definition for more details. Must use LHL gpios.

Parameters
[in]ctx_pin: Tx control signal of external power amplifier.
[in]crx_pin: Rx control signal of external power amplifier if used. Use WICED_GPIO_NOT_USED if not used.
[in]csd_byp_pin: CSD or BYP control signal of external power amplifier if used. Use WICED_GPIO_NOT_USED if not used.
Returns
: WICED_SUCCESS, WICED_ERROR