ipmb.h

Go to the documentation of this file.

/*
 *   openMMC -- Open Source modular IPM Controller firmware
 *
 *   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 IPMB_H_
#define IPMB_H_
 
/* FreeRTOS includes */
#include "FreeRTOS.h"
#include "task.h"
#include "queue.h"
#include "semphr.h"
#include "board_ipmb.h"
 
 
#define IPMB_ADDR_DISCONNECTED  0xA2
 
#define IPMB_TXQUEUE_LEN        10
 
#define IPMB_CLIENT_QUEUE_LEN   10
 
#define IPMB_MAX_RETRIES        3
 
#define IPMB_MSG_TIMEOUT        250/portTICK_PERIOD_MS
 
#define CLIENT_NOTIFY_TIMEOUT   5
 
#define IPMI_HEADER_CHECKSUM_POSITION      2
 
#define IPMI_MSG_MAX_LENGTH         32
 
#define IPMB_REQ_HEADER_LENGTH      6
 
#define IPMB_RESP_HEADER_LENGTH     7
 
#define IPMB_NETFN_MASK         0xFC
#define IPMB_DEST_LUN_MASK      0x03
#define IPMB_SEQ_MASK           0xFC
#define IPMB_SRC_LUN_MASK       0x03
 
#define MCH_ADDRESS             0x20
 
#define IS_RESPONSE(msg) (msg.netfn & 0x01)
 
#define IPMBL_TABLE_SIZE                27
 
typedef enum {
    GROUNDED = 0,
    POWERED,
    UNCONNECTED
} GA_Pin_state;
 
typedef struct ipmi_msg {
    uint8_t dest_addr;                  
    uint8_t netfn;                      
    uint8_t dest_LUN;                   
    uint8_t hdr_chksum;                 
    uint8_t src_addr;                   
    uint8_t seq;                        
    uint8_t src_LUN;                    
    uint8_t cmd;                        
    uint8_t completion_code;            
    uint8_t data_len;                   
    uint8_t data[IPMI_MSG_MAX_LENGTH];  
    uint8_t msg_chksum;                 
} ipmi_msg;
 
typedef struct ipmi_msg_cfg {
    ipmi_msg buffer;                    
    TaskHandle_t caller_task;           
    uint8_t retries;                    
    uint32_t timestamp;                 
} ipmi_msg_cfg;
 
typedef enum ipmb_error {
    ipmb_error_unknown = 0,             
    ipmb_error_success,                 
    ipmb_error_failure,                 
    ipmb_error_timeout,                 
    ipmb_error_invalid_req,             
    ipmb_error_hdr_chksum,              
    ipmb_error_msg_chksum,              
    ipmb_error_queue_creation           
} ipmb_error;
 
extern uint8_t ipmb_addr;
 
/* Function Prototypes */
 
void IPMB_TXTask ( void *pvParameters );
 
void IPMB_RXTask ( void *pvParameters );
 
void ipmb_init ( void );
 
ipmb_error ipmb_send_request ( ipmi_msg * req );
 
ipmb_error ipmb_send_response ( ipmi_msg * req, ipmi_msg * resp );
 
ipmb_error ipmb_register_rxqueue ( QueueHandle_t * queue );
 
ipmb_error ipmb_assert_chksum ( uint8_t * buffer, uint8_t buffer_len );
 
uint8_t get_ipmb_addr( void );
 
#endif