1 /**
2 * \ingroup MODULBIOS
3 *
4 * \file protocol.h
5 *
6 * \brief <FILEBRIEF>
7 *
8 */
9 /*
10  * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
11  *
12  *
13  *  Redistribution and use in source and binary forms, with or without
14  *  modification, are permitted provided that the following conditions
15  *  are met:
16  *
17  *    Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  *
20  *    Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in the
22  *    documentation and/or other materials provided with the
23  *    distribution.
24  *
25  *    Neither the name of Texas Instruments Incorporated nor the names of
26  *    its contributors may be used to endorse or promote products derived
27  *    from this software without specific prior written permission.
28  *
29  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40  */
41 
42 /**
43  @page protocol Host (PC) - Bios Communication Protocol
44  This page introduces the user to the topic.
45  Proceed to the @ref hil.
46 */
47 
48 /**
49  @file protocol.h
50  @brief Host (PC) - Bios Communication Protocol
51 
52  This file defines and exports all the objects and symbols required to use
53  the Host (PC) - Bios Communication Protocol.
54 */
55 
56 #ifndef _BIOS_PROTOCOL_H_
57 #define _BIOS_PROTOCOL_H_
58 
59 enum eCMDTYP
60 {
61     // Fet-Core functions
62     CMDTYP_UPINIT               = 0x51,
63     CMDTYP_UPERASE              = 0x52,
64     CMDTYP_UPWRITE              = 0x53,
65     CMDTYP_UPREAD               = 0x54,
66     CMDTYP_UPCORE               = 0x55,
67     // Fet-Dcdc functions
68     CMDTYP_DCDC_CALIBRATE       = 0x56,
69     CMDTYP_DCDC_INIT_INTERFACE  = 0x57,
70     CMDTYP_DCDC_SUB_MCU_VERSION = 0x58,
71     CMDTYP_DCDC_LAYER_VERSION   = 0x59,
72     CMDTYP_DCDC_POWER_DOWN      = 0x60,
73     CMDTYP_DCDC_SET_VCC         = 0x61,
74 
75     CMDTYP_DCDC_RESTART         = 0x62,
76 
77     CMDTYP_HIL_SET_VCC          = 0x63,
78     CMDTYP_HIL_GET_VCC          = 0x64,
79     CMDTYP_HIL_SWITCH_FET       = 0x65,
80 
81     CMDTYP_CMP_VERSIONS         = 0x66,
82 
83     CMDTYP_LEGACY               = 0x7E,
84     CMDTYP_SYNC                 = 0x80,
85     CMDTYP_EXECUTE              = 0x81,
86     CMDTYP_EXECUTELOOP          = 0x82,
87     CMDTYP_LOAD                 = 0x83,
88     CMDTYP_LOAD_CONTINUED       = 0x84,
89     CMDTYP_DATA                 = 0x85,
90     CMDTYP_KILL                 = 0x86,
91     CMDTYP_MOVE                 = 0x87,
92     CMDTYP_UNLOAD               = 0x88,
93     CMDTYP_BYPASS               = 0x89,
94     CMDTYP_EXECUTEEVER          = 0x8A,
95     CMDTYP_COMRESET             = 0x8B,
96     CMDTYP_PAUSE_LOOP           = 0x8C,
97     CMDTYP_RESUME_LOOP          = 0x8D,
98     CMDTYP_KILL_ALL             = 0x8E,
99     CMDTYP_OVER_CURRENT         = 0x8F
100 };
101 typedef enum eCMDTYP eCMDTYP_t;
102 
103 
104 enum eRESPTYP
105 {
106     RESPTYP_EMPTY          = 0x00,
107     RESPTYP_ACKNOWLEDGE    = 0x91,
108     RESPTYP_EXCEPTION      = 0x92,
109     RESPTYP_DATA           = 0x93,
110     RESPTYP_REQUEST        = 0x94,
111     RESPTYP_STATUS         = 0x95,
112 };
113 
114 typedef enum eRESPTYP eRESPTYP_t;
115 
116 #endif
117