saf_sap.h 6.92 KB
/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*------------------------SAF_MSG_CODE_BEGIN ---------------*/
#ifdef __BUILD_DOM__
/*****************************************************************************
* <GROUP  Messages>        
*
* SAF SAP Primitives
******************************************************************************/
typedef enum {
#endif /* __BUILD_DOM__ */
   /* MSG FROM APP */

   /* This primitive is used to open the channel.
   *
   * Direction: APP -> SAF
   * Local parameter: app_saf_open_channel_req_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_OPEN_CHANNEL_REQ = SAF_MSG_CODE_BEGIN,
   
   /* This primitive is used to abort the open channel request.
   *
   * Direction: APP -> SAF
   * Local parameter: app_saf_abort_open_channel_req_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_ABORT_OPEN_CHANNEL_REQ,
   
   /* This primitive is used to close the channel.
   *
   * Direction: APP -> SAF
   * Local parameter: app_saf_close_channel_req_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_CLOSE_CHANNEL_REQ,
   
   /* This primitive is used to get the derived IP address and port number.
   *
   * Direction: APP -> SAF
   * Local parameter: app_saf_get_derived_addr_req_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_GET_DERIVED_ADDR_REQ,
   
   /* This primitive is used to abort getting derived address request.
   *
   * Direction: APP -> SAF
   * Local parameter: app_saf_abort_get_derived_addr_req_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_ABORT_GET_DERIVED_ADDR_REQ,
   
   /* This primitive is used to get the NAT type.
   *
   * Direction: APP -> SAF
   * Local parameter: app_saf_get_nat_type_req_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_GET_NAT_TYPE_REQ,
   
   /* This primitive is used to get the NAT type.
   *
   * Direction: APP -> SAF
   * Local parameter: app_saf_abort_get_nat_type_req_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_ABORT_GET_NAT_TYPE_REQ,
   
   /* This primitive is used to get the NAT binding lifetime.
   *
   * Direction: APP -> SAF
   * Local parameter: app_saf_get_nat_binding_lifetime_req_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_GET_NAT_BINDING_LIFETIME_REQ,
   
   /* This primitive is used to abort get the NAT binding lifetime request.
   *
   * Direction: APP -> SAF
   * Local parameter: app_saf_abort_get_nat_lifetime_req_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_ABORT_GET_NAT_BINDING_LIFETIME_REQ,
   

   /********************** MSG TO APP *****************************/   

   /* This primitive is used for confirmation of open channel request.
   *
   * Direction: SAF -> APP
   * Local parameter: app_saf_open_channel_cnf_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_OPEN_CHANNEL_CNF,
   
   /* This primitive is used for confirmation of abort open channel request.
   *
   * Direction: SAF -> APP
   * Local parameter: app_saf_abort_open_channel_cnf_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_ABORT_OPEN_CHANNEL_CNF,
   
   /* This primitive is used for confirmation of close channel request.
   *
   * Direction: SAF -> APP
   * Local parameter: app_saf_close_channel_cnf_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_CLOSE_CHANNEL_CNF,
   
   /* This primitive is used for confirmation of get derived address request.
   *
   * Direction: SAF -> APP
   * Local parameter: app_saf_get_derived_addr_cnf_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_GET_DERIVED_ADDR_CNF,
   
   /* This primitive is used for confirmation of aborting get derived address request.
   *
   * Direction: SAF -> APP
   * Local parameter: app_saf_abort_get_derived_addr_cnf_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_ABORT_GET_DERIVED_ADDR_CNF,
   
   /* This primitive is used for confirmation of get NAT type request.
   *
   * Direction: SAF -> APP
   * Local parameter: app_saf_get_nat_type_cnf_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_GET_NAT_TYPE_CNF,
   
   /* This primitive is used for confirmation of aborting get NAT type request.
   *
   * Direction: SAF -> APP
   * Local parameter: app_saf_abort_get_nat_type_cnf_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_ABORT_GET_NAT_TYPE_CNF,
   
   /* This primitive is used for confirmation of get binding lifetime request.
   *
   * Direction: SAF -> APP
   * Local parameter: app_saf_get_nat_binding_lifetime_cnf_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_GET_NAT_BINDING_LIFETIME_CNF,
   
   /* This primitive is used for confirmation of aborting get binding lifetime request.
   *
   * Direction: SAF -> APP
   * Local parameter: app_saf_abort_get_nat_lifetime_cnf_struct
   * Peer buffer: None
   */
   MSG_ID_APP_SAF_ABORT_GET_NAT_BINDING_LIFETIME_CNF,

   MSG_ID_APP_SAF_CODE_END = MSG_ID_APP_SAF_ABORT_GET_NAT_BINDING_LIFETIME_CNF,
   /* to prevent range msg_id filter usage for APP */
/*------------------- SAF_MSG_CODE_END----------------------*/
#ifdef __BUILD_DOM__
   } sap_saf_enum;
#endif /* __BUILD_DOM__ */