dhcp4cApi.h

Go to the documentation of this file.

/*
 * If not stated otherwise in this file or this component's LICENSE file the
 * following copyright and licenses apply:
 *
 * Copyright 2016 RDK Management
 *
 * 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.
*/
/**
* @file dhcp4cApi.h
* @brief For CCSP Component: DHCP4-Client Status
*
* @description This header file gives the function call prototypes and structure definitions used for the RDK-Broadband DHCP4Client Status abstraction layer.
*/
#ifndef _DHCP4_CLIENT_API_
#define _DHCP4_CLIENT_API_
 
/**
 * @defgroup DHCPV4C_HAL DHCPV4C HAL
 *
 * DHCPv4C HAL is used for the RDK-B DHCPv4 Client Status abstraction layer.
 *
 * @defgroup DHCPV4C_HAL_TYPES  DHCPV4C HAL Data Types
 * @ingroup  DHCPV4C_HAL
 *
 * @defgroup DHCPV4C_HAL_APIS   DHCPV4C HAL APIs
 * @ingroup  DHCPV4C_HAL
 *
 **/
 
/**
 * @addtogroup DHCPV4C_HAL_TYPES
 * @{
 */
enum DHCPC_CMD{
        DHCPC_CMD_LEASE_TIME = 0,
        DHCPC_CMD_LEASE_TIME_REMAIN,
        DHCPC_CMD_RENEW_TIME_REMAIN,
        DHCPC_CMD_REBIND_TIME_REMAIN,
        DHCPC_CMD_CONFIG_ATTEMPTS,
        DHCPC_CMD_GET_IFNAME,
        DHCPC_CMD_FSM_STATE,
        DHCPC_CMD_IP_ADDR,
        DHCPC_CMD_IP_MASK,
        DHCPC_CMD_ROUTERS,
        DHCPC_CMD_DNS_SVRS,
        DHCPC_CMD_DHCP_SVR,
        
        DHCPC_CMD_MAX
};
 
enum DHCPC_MODULE{
        DHCPC_ECM = 0,
        DHCPC_EROUTER,
    DHCPC_EMTA
};
 
#define MAX_IPV4_ADDR_LIST_NUMBER       4
 
typedef struct{
        int     number;
        unsigned int addrList[MAX_IPV4_ADDR_LIST_NUMBER];
}ipv4AddrList_t;
 
/** @} */  //END OF GROUP DHCPV4C_HAL_TYPES
 
/**
 * @addtogroup DHCPV4C_HAL_APIS
 * @{
 */
 
/* dhcp4c_get_ert_lease_time() function */
/**
* @description Gets the E-Router Offered Lease Time
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_lease_time(unsigned int *pValue);
 
/* dhcp4c_get_ert_remain_lease_time() function */
/**
* @description Gets the E-Router Remaining Lease Time
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_remain_lease_time(unsigned int *pValue);
 
/* dhcp4c_get_ert_remain_renew_time() function */
/**
* @description Gets the E-Router Interface Remaining Time to Renew
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_remain_renew_time(unsigned int *pValue);
 
/* dhcp4c_get_ert_remain_rebind_time() function */
/**
* @description Gets the E-Router Interface Remaining Time to Rebind
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_remain_rebind_time(unsigned int *pValue);
 
/* dhcp4c_get_ert_config_attempts() function */
/**
* @description Gets the E-Router Number of Attemts to Configure.
* @param
*    pValue - Count.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_config_attempts(int *pValue);
 
/* dhcp4c_get_ert_ifname() function */
/**
* @description Gets the E-Router Interface Name.
* @param
*    pName - Interface Name (e.g. ert0)
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_ifname(char *pName);
 
/* dhcp4c_get_ert_fsm_state() function */
/**
* @description Gets the E-Router DHCP State
* @param
*    pValue - State of the DHCP (RENEW/ACQUIRED etc.)
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_fsm_state(int *pValue);
 
/* dhcp4c_get_ert_ip_addr() function */
/**
* @description Gets the E-Router Interface IP Address
* @param
*    pValue - IP Address (of the Interface)
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_ip_addr(unsigned int *pValue);
 
/* dhcp4c_get_ert_mask() function */
/**
* @description Gets the E-Router Subnet Mask.
* @param
*    pValue - Subnet Mask (bitmask)
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_mask(unsigned int *pValue);
 
/* dhcp4c_get_ert_gw() function */
/**
* @description Gets the E-Router Gateway IP Address
* @param
*    pValue - IP Address (of the Gateway)
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_gw(unsigned int *pValue);
 
/* dhcp4c_get_ert_dns_svrs() function */
/**
* @description Gets the E-Router List of DNS Servers
* @param
*    pList - List of IP Address (of DNS Servers)
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_dns_svrs(ipv4AddrList_t *pList);
 
/* dhcp4c_get_ert_dhcp_svr() function */
/**
* @description Gets the E-Router DHCP Server IP Address
* @param
*    pValue - IP Address (of DHCP Server)
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ert_dhcp_svr(unsigned int *pValue);
 
/* dhcp4c_get_ecm_lease_time() function */
/**
* @description Gets the ECM Offered Lease Time.
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_lease_time(unsigned int *pValue);
 
/* dhcp4c_get_ecm_remain_lease_time() function */
/**
* @description Gets the ECM Remaining Lease Time
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_remain_lease_time(unsigned int *pValue);
 
/* dhcp4c_get_ecm_remain_renew_time() function */
/**
* @description Gets the ECM Interface Remaining time to Renew.
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_remain_renew_time(unsigned int *pValue);
 
/* dhcp4c_get_ecm_remain_rebind_time() function */
/**
* @description Gets the ECM Interface Remaining time to Rebind.
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_remain_rebind_time(unsigned int *pValue);
 
/* dhcp4c_get_ecm_config_attempts() function */
/**
* @description Gets the ECM Configuration Number of Attemts.
* @param
*    pValue - Count.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_config_attempts(int *pValue);
 
/* dhcp4c_get_ecm_ifname() function */
/**
* @description Gets the ECM Interface Name.
* @param
*    pName - Name of the Interface (e.g doc0)
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_ifname(char *pName);
 
/* dhcp4c_get_ecm_fsm_state() function */
/**
* @description Gets the ECM DHCP State
* @param
*    pValue - State of the DHCP (RENEW/ACQUIRED etc)
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_fsm_state(int *pValue);
 
/* dhcp4c_get_ecm_ip_addr() function */
/**
* @description Gets the ECM Interface IP Address
* @param
*    pValue - IP Address of the Interface.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_ip_addr(unsigned int *pValue);
 
/* dhcp4c_get_ecm_mask() function */
/**
* @description Gets the ECM Interface Subnet Mask.
* @param
*    pValue - Subnet Mask (bitmask).
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_mask(unsigned int *pValue);
 
/* dhcp4c_get_ecm_gw() function */
/**
* @description Gets the ECM Gateway IP Address
* @param
*    pValue - IP Address of Gateway
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_gw(unsigned int *pValue);
 
/* dhcp4c_get_ecm_dns_svrs() function */
/**
* @description Gets the ECM List of DNS Servers
* @param
*    pList - List of IP Addresses (of DNS Servers)
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_dns_svrs(ipv4AddrList_t *pList);
 
/* dhcp4c_get_ecm_dhcp_svr() function */
/**
* @description Gets the ECM DHCP Server IP Address
* @param
*    pValue - IP Address 
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_ecm_dhcp_svr(unsigned int *pValue);
 
/* dhcp4c_get_emta_remain_lease_time() function */
/**
* @description Gets the E-MTA interface Least Time
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_emta_remain_lease_time(unsigned int *pValue);
 
/* dhcp4c_get_emta_remain_renew_time() function */
/**
* @description Gets the E-MTA interface Remaining Time to Renew
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_emta_remain_renew_time(unsigned int *pValue);
 
/* dhcp4c_get_emta_remain_rebind_time() function */
/**
* @description Gets the E-MTA interface Remaining Time to Rebind
* @param
*    pValue - Value in Seconds.
* @return The status of the operation.
* @retval STATUS_SUCCESS if successful.
* @retval STATUS_FAILURE if any error is detected
*
* @execution Synchronous.
* @sideeffect None.
*
* @note This function must not suspend and must not invoke any blocking system
* calls. It should probably just send a message to a driver event handler task.
*
*/
int dhcp4c_get_emta_remain_rebind_time(unsigned int *pValue);
 
/** @} */  //END OF GROUP DHCPV4C_HAL_APIS
 
#endif