summaryrefslogtreecommitdiffstats
path: root/src/usr/ipmiext/ipmiwatchdog.C
blob: 5f7b9bde053ec7773b9d5c8ab3a5e151eda6bf38 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/ipmiext/ipmiwatchdog.C $                              */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2014,2018                        */
/* [+] Google Inc.                                                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#ifndef __IPMIWATCHDOG_IPMIWATCHDOG_C
#define __IPMIWATCHDOG_IPMIWATCHDOG_C
/**
 *  @file ipmiwatchdog.C
 *
 *  Ipmi watchdog timer
 *
 */

/******************************************************************************/
// Includes
/******************************************************************************/
#include <stdint.h>
#include <errl/errlentry.H>
#include <ipmi/ipmiwatchdog.H>
#include <ipmi/ipmiif.H>
#include <sys/time.h>
#include <time.h>

/******************************************************************************/
// Globals/Constants
/******************************************************************************/
// Defined in ipmidd.C
extern trace_desc_t * g_trac_ipmi;
#define IPMI_TRAC(printf_string,args...) \
    TRACFCOMP(g_trac_ipmi,"wd: " printf_string,##args)

namespace IPMIWATCHDOG
{

// Needed for watchdog resets in case the BMC side becomes uninitialized and we
// need to reinitialize it
static bool g_set_once = false;
static uint16_t g_countdown_secs;
static uint8_t g_timer_use;
static TIMER_ACTIONS g_timer_action;
static TIMER_USE_CLR_FLAGS g_timer_clr_flag;

/******************************************************************************/
// Functions
/******************************************************************************/


errlHndl_t setWatchDogTimer(  const uint16_t i_countdown_secs,
                        const uint8_t i_timer_use,
                        const TIMER_ACTIONS i_timer_action,
                        const TIMER_USE_CLR_FLAGS i_timer_clr_flag)
{
    // Save the latest values so that reset actions can setup the timer
    // if the BMC goes away.
    g_set_once = true;
    g_countdown_secs = i_countdown_secs;
    g_timer_use = i_timer_use;
    g_timer_action = i_timer_action;
    g_timer_clr_flag = i_timer_clr_flag;

    // Convert secs into lsb and msb values
    // the ipmi spec uses the count which is 100ms/count
    static const uint16_t ms_per_count               = 100;
    static const uint8_t bits_to_shift_for_nxt_byte  = 8;
    static const uint8_t byte_mask                   = 0xFF;

    uint16_t countdown = (i_countdown_secs * MS_PER_SEC)
                            / ms_per_count;

    uint8_t init_countdown_lsb = static_cast<uint8_t>
                                 (countdown & byte_mask);

    uint8_t init_countdown_msb = static_cast<uint8_t>(
                                 (countdown >> bits_to_shift_for_nxt_byte)
                                 & byte_mask);


    size_t len = 6; // IPMI spec has request data at 6 bytes

    //create request data buffer
    uint8_t* data = new uint8_t[len];

    data[0] = i_timer_use;          // byte 1 timer use
    data[1] = i_timer_action;      // byte 2 timer actions
    data[2] = 0x00;                 // byte 3 pre-interval timeout in secs
    data[3] = i_timer_clr_flag;    // byte 4 timer use flags to clear
    data[4] = init_countdown_lsb; // byte 5 initial countdown timer LSByte
    data[5] = init_countdown_msb; // byte 6 initial countdown timer MSByte

    IPMI_TRAC( "setWatchDogTimer : sec=%d, use=%d, act=%d, clr=%d",
               i_countdown_secs,
               i_timer_use,
               i_timer_action,
               i_timer_clr_flag );
    return IPMI::send(IPMI::set_watchdog(), len, data);

}


errlHndl_t resetWatchDogTimer()
{
    errlHndl_t err_ipmi = NULL;

    // Limit the amount of sent watchdog resets to once per second to make
    // sure that we don't overload the BMC with resets during quickly
    // completing ISTEPs. For simplicity we only compare the tv_sec so
    // the grace period may be almost 2 seconds.
    static uint64_t last_reset_sec;
    timespec_t now;
    clock_gettime(CLOCK_MONOTONIC, &now);
    if (last_reset_sec + 1 >= now.tv_sec)
    {
        return NULL;
    }
    last_reset_sec = now.tv_sec;

    // reset command does not take any request data
    size_t len = 0;
    uint8_t* data = NULL;


    do
    {
        IPMI_TRAC( "resetWatchDogTimer" );

        IPMI::completion_code cc;
        err_ipmi = IPMI::sendrecv(IPMI::reset_watchdog(), cc, len, data);
        delete[] data;

        if(err_ipmi)
        {
            //got an error sending IPMI msg
            //progate error upstream.
            break;
        }

        // Make sure we don't have an uninitialized watchdog
        // openbmc will always start the watchdog regardless of us
        // initializing it. If we don't initialize it, it can eventually
        // time out on us
        if (g_set_once && cc == IPMI::CC_CMDSPC1)
        {
            err_ipmi = setWatchDogTimer(g_countdown_secs,
                    g_timer_use | DO_NOT_STOP,
                    g_timer_action, g_timer_clr_flag);

            if (err_ipmi)
            {
                //got an error sending IPMI msg
                //progate error upstream.
                break;
            }

            // Make sure to issue a reset after initialization to start
            // the timer if it isn't already. We don't care about the return
            // value of this message since we can't recurse forever. If we
            // fail here, later resets should handle reconfiguring the
            // watchdog if it isn't critically broken.
            len = 0;
            data = NULL;
            err_ipmi = IPMI::send(IPMI::reset_watchdog(), len, data);

            if(err_ipmi)
            {
                //got an error sending IPMI msg
                //progate error upstream.
                break;
            }
        }

        // We don't care about any other types of errors as the watchdog
        // will just trip in these cases.
        break;
    }
    while(0);

    return err_ipmi;
}


} // namespace

#endif
OpenPOWER on IntegriCloud