payload.h

Go to the documentation of this file.

/*
 *   openMMC -- Open Source modular IPM Controller firmware
 *
 *   Copyright (C) 2015  Piotr Miedzik  <P.Miedzik@gsi.de>
 *   Copyright (C) 2015-2016  Henrique Silva <henrique.silva@lnls.br>
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *   @license GPL-3.0+ <http://spdx.org/licenses/GPL-3.0+>
 */
 
#ifndef PAYLOAD_H_
#define PAYLOAD_H_
 
#include "event_groups.h"
#include "mmc_error.h"
 
extern enum {
    PAYLOAD_NO_POWER = 0,
    PAYLOAD_POWER_GOOD_WAIT,
    PAYLOAD_STATE_FPGA_SETUP,
    PAYLOAD_FPGA_ON,
    PAYLOAD_SWITCHING_OFF,
    PAYLOAD_QUIESCED,
    PAYLOAD_RESET,
    PAYLOAD_MAX_STATES
} payload_state;
 
#define PAYLOAD_MESSAGE_COLD_RST        (1 << 0)
#define PAYLOAD_MESSAGE_WARM_RST        (1 << 1)
#define PAYLOAD_MESSAGE_REBOOT          (1 << 2)
#define PAYLOAD_MESSAGE_QUIESCE         (1 << 3)
#define PAYLOAD_MESSAGE_RTM_ENABLE      (1 << 4)
#define PAYLOAD_MESSAGE_CLOCK_CONFIG    (1 << 5)
#define PAYLOAD_BASE_DELAY 100
 
extern TaskHandle_t vTaskPayload_Handle;
 
void payload_send_message( uint8_t fru_id, EventBits_t msg );
 
void vTaskPayload( void *pvParameters );
 
void payload_init( void );
 
#ifdef MODULE_HPM
 
#define PAYLOAD_HPM_PAGE_SIZE    256
 
uint8_t payload_hpm_prepare_comp( void );
uint8_t payload_hpm_upload_block( uint8_t * block, uint16_t size );
uint8_t payload_hpm_finish_upload( uint32_t image_size );
uint8_t payload_hpm_get_upgrade_status( void );
uint8_t payload_hpm_activate_firmware( void );
#endif
 
mmc_err clock_configuration(const uint8_t clk_cfg[16]);
 
#endif /* IPMI_PAYLOAD_H_ */