rtm_user.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 RTM_USER_H_
#define RTM_USER_H_
 
/* PCA9554 outputs */
#define RTM_GPIO_HOTSWAP_HANDLE         0
#define RTM_GPIO_OVERTEMP_SHUTDOWN      4
#define RTM_GPIO_LED_RED                5
#define RTM_GPIO_LED_GREEN              6
#define RTM_GPIO_LED_BLUE               7
 
#define RTM_GPIO_VS1_EN                 0
#define RTM_GPIO_VS2_EN                 1
#define RTM_GPIO_7V_EN                  2
#define RTM_GPIO_5V_EN                  3
#define RTM_GPIO_NEG_7V_EN              4
 
#include "mmc_error.h"
 
/* Mandatory RTM module functions */
mmc_err rtm_enable_payload_power_post( void );
mmc_err rtm_disable_payload_power_pre( void );
uint8_t rtm_get_hotswap_handle_status( uint8_t *state );
void rtm_hardware_init( void );
void rtm_ctrl_led( uint8_t id, uint8_t state );
uint8_t rtm_read_led( uint8_t id );
bool rtm_compatibility_check( void );
 
/* User defined functions */
void rtm_enable_i2c( void );
void rtm_disable_i2c( void );
 
#endif