ath9k_htc/target_firmware/magpie_fw_dev/target/cmnos/dbg_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 /*                                                                      */
  37 /*  FILE DESCRIPTION                                                    */
  38 /*                                                                      */
  39 /*  This file contains console debug command table structure and        */
  40 /*  relative defination.                                                */
  41 /*                                                                      */
  42 /*  ROUTINES                                                            */
  43 /*                                                                      */
  44 /*      None                                                            */
  45 /*                                                                      */
  46 /*  NOTES                                                               */
  47 /*                                                                      */
  48 /*      None                                                            */
  49 /*                                                                      */
  50 /************************************************************************/
  51 #ifndef _DB_DEFS_H
  52 #define _DB_DEFS_H
  53
  54 #define ATH_DEBUGGER_VERSION_STR     "Magpie Debugger: "ATH_VERSION_STR
  55 #define ATH_COMMAND_LIST_STR         "\n\r===Command Listing===\n\r"
  56
  57 #define DB_MAX_COMMAND_LENGTH       40   /* Maximum command line length */
  58 #define COMMAND_BUFFER_SIZE         6    /* Maximum command buffer size */
  59
  60 struct DB_COMMAND_STRUCT
  61 {
  62     char* cmd_str;                         /* Command string */
  63     char* help_str;                        /* Help description */
  64     int (*cmd_func)(char *, char*, char*, char*);  /* Command function */
  65 };
  66
  67 #define zm_get_char(x)     A_GETC(x)
  68
  69 /******** hardware API table structure (API descriptions below) *************/
  70 struct dbg_api {
  71     void (*_dbg_init)(void);
  72     void (*_dbg_task)(void);
  73 };
  74
  75
  76 #endif