view src/g23m-aci/bat/bat.h @ 78:c632896652ba

mfw/ti1_key.c: properly initialize notified_keys array The code in this ti1_key.c layer needs to call kpd_subscribe() and kpd_define_key_notification() functions in order to register with the KPD driver. The original code passed KPD_NB_PHYSICAL_KEYS in nb_notified_keys - this constant is defined to 24 in kpd_cfg.h on all platforms of interest to us - but it only filled the first 23 slots in the notified_keys array, resulting in stack garbage being passed to KPD API functions. The fix consists of initializing the last missed array slot to KPD_KEY_RECORD, the key ID for the right side button on the D-Sample handset. On our current hw targets this "Record" button exists as the EXTRA button on our Luna keypad board and as the camera button on the Pirelli DP-L10. There is no support whatsoever for this button in current BMI+MFW, we have no plans of doing anything with Pirelli's camera button even if we do get our UI fw running on that phone, and the Mother's dream of building our own FreeCalypso handset with the same button arrangement as D-Sample (including the right side button) is currently very nebulous - but let us nonetheless handle the full set of buttons on the KPD to MFW interface, and let upper layers weed out unsupported buttons.
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 25 Oct 2020 23:41:01 +0000
parents fa8dc04885d8
children
line wrap: on
line source

/*  
+-----------------------------------------------------------------------------
|  Project :  GSM-F&D (8411)
|  Modul   :  BAT library
+-----------------------------------------------------------------------------
|  Copyright 2005 Texas Instruments Berlin, AG
|                 All rights reserved.
|
|                 This file is confidential and a trade secret of Texas
|                 Instruments Berlin, AG
|                 The receipt of or possession of this file does not convey
|                 any rights to reproduce or disclose its contents or to
|                 manufacture, use, or sell anything it may describe, in
|                 whole, or in part, without the specific written consent of
|                 Texas Instruments Berlin, AG.
+-----------------------------------------------------------------------------
|  Purpose :  API for binary AT commands
+-----------------------------------------------------------------------------
*/

#ifndef BAT_H 
#define BAT_H

#ifndef __TYPEDEFS_H__
#include "typedefs.h"     /* for customers without busybe */
#endif

#include "p_bat.h"        /* to include the p_bat.h */
#include "bat_types.h"    /* to include the types for internal maintainance */
#include "bat_cfg.h"      /* to include the configuration settings */


/*********************************************************************************
 *
 * defines
 *
 *********************************************************************************/

#define BAT_INSTANCE_HEADER_SIZE ((unsigned short)sizeof(void*))
#define BAT_INSTANCE_SIZE ((unsigned short)sizeof(T_BAT_instance_maintain) + (unsigned short)L2P_MAINTAIN_SIZE)                
#define BAT_CLIENT_SIZE ((unsigned short)sizeof(T_BAT_client_maintain))


/*********************************************************************************
 *
 * enumerations
 *
 *********************************************************************************/

typedef enum
{
  BAT_OK = 0,
  BAT_BUSY_RESOURCE,
  BAT_ERROR
}T_BAT_return;

typedef enum
{
  BAT_ABORT = 0,
  BAT_APP_READY_RESOURCE
}T_BAT_event;


/*********************************************************************************
 *
 * structures
 *
 *********************************************************************************/

typedef struct
{
  T_BAT_event          event; 
} T_BAT_ctrl;


/*********************************************************************************
 *
 * function declarations
 *
 *********************************************************************************/

extern T_BAT_return bat_init   (void            *mem, 
                                unsigned char   num);
extern T_BAT_return bat_deinit (void);
extern T_BAT_return bat_new    (T_BAT_instance  *instance,
                                void            *mem,
                                unsigned char   num,
                                T_BAT_config    *config,
                                void            (*instance_signal_cb)(T_BAT_signal signal));
extern T_BAT_return bat_delete (T_BAT_instance  instance);
extern T_BAT_return bat_open   (T_BAT_instance  instance, 
                                T_BAT_client    *client,
                                int             (*response_cb)(T_BAT_client client, 
                                                               T_BAT_cmd_response *response),
                                void            (*signal_cb)  (T_BAT_client client, 
                                                               T_BAT_signal signal));
extern T_BAT_return bat_uns_open(T_BAT_instance instance, 
                                 T_BAT_client   *client,  
                                 int   (*unsolicited_result_cb)( T_BAT_client client, 
                                                                 T_BAT_cmd_response *response));
extern T_BAT_return bat_close  (T_BAT_client    client);
extern T_BAT_return bat_send   (T_BAT_client    client, 
                                T_BAT_cmd_send  *cmd);
extern T_BAT_return bat_ctrl   (T_BAT_client    client, 
                                T_BAT_ctrl      *ctrl);


#endif /*BAT_H*/