ath9k_htc/sboot/magpie_1_1/inc/romp_api.h

   1 /*
   2  * Copyright (c) 2013 Qualcomm Atheros, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted (subject to the limitations in the
   7  * disclaimer below) provided that the following conditions are met:
   8  *
   9  *  * Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  *  * Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the
  15  *    distribution.
  16  *
  17  *  * Neither the name of Qualcomm Atheros nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific prior written permission.
  20  *
  21  * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
  22  * GRANTED BY THIS LICENSE.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
  23  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
  24  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  26  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  30  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  32  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  33  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35 /*************************************************************************/
  36 /*  Copyright (c) 2008 Atheros Communications, Inc., All Rights Reserved */
  37 /*                                                                       */
  38 /*  Module Name : romp_api.h                                                     */
  39 /*                                                                       */
  40 /*  Abstract                                                             */
  41 /*      This file contains definition of data structure and interface    */
  42 /*                                                                       */
  43 /*  NOTES                                                                */
  44 /*      None                                                             */
  45 /*                                                                       */
  46 /*************************************************************************/
  47
  48 #ifndef _ROMP_API_H_
  49 #define _ROMP_API_H_
  50
  51 #include "dt_defs.h"
  52
  53 /******** hardware API table structure (API descriptions below) *************/
  54 struct romp_api {
  55     void (*_romp_init)(void);
  56     BOOLEAN (*_romp_download)(uint16_t );
  57     BOOLEAN (*_romp_install)(void);
  58     BOOLEAN (*_romp_decode)(uint32_t );
  59 };
  60
  61 #define _ROMP_MAGIC_ "[PaTcH]"
  62
  63 struct rom_patch_st {
  64     uint16_t crc16;             // crc filed to maintain the integrity
  65     uint16_t len;               // length of the patch code
  66     uint32_t ld_addr;   // load address of the patch code
  67         uint32_t fun_addr;  // entry address of the patch code
  68     uint8_t *pfun;              // patch code
  69 };
  70
  71
  72 struct eep_redir_addr {
  73     uint16_t offset;
  74     uint16_t size;
  75 };
  76
  77
  78 /************************* EXPORT function ***************************/
  79 uint16_t cal_crc16(uint32_t sz, uint8_t *p);
  80
  81 #endif  // end of _UART_API_H_
  82