Page History

...

• HAL APIs will be available in the CMF repo path: "../rdkb/components/opensource/ccsp/hal/source/"
• PandM HAL Integration (back-end) Layer is also known as component specific HAL.
• This layer makes call to underlying Linux system calls/commands, third party modules, open source modules and other CCSP components to execute the requests.
• This layer will be more component specific and will be providing APIs to CCSP so as to manage a particular hardware module of the system.
• Following are some of the  component specific  HALs available in "../rdkb/components/opensource/ccsp/hal/source/" path.
  
  • Wifi  
  • MoCA
  • MTA Agent
  • CM   
  • Ethernet Switch
  • DHCPv4C
  • VLAN
  • Firewall
  • DPoE
  • Bluetooth
  • MSO_Management
  • Voice
  • WAN
  • TR69_TLV

Wi-Fi HAL 

       All HAL functions prototypes and structure definitions are available in wifi_hal.h file.

• WI-fI HAL is used for the RDK-Broadband Wifi radio hardware abstraction layer.
• Latest version of RDKB supports 300+ Wi-Fi HAL API’s.
• Based on how Wi-Fi vendor exposes their driver capabilities in user space, the HAL API’s can be implemented in wifi_hal.c
• Some of the APIs are : 
  1. wifi_getRadioChannelStats
  2. wifi_getRadioChannelStats2
  3. wifi_getWifiChannelStatsgetApAssociatedDeviceRxStatsResult
  4. wifi_getApAssociatedDeviceTxStatsResult
  5. wifi_getApAssociatedDeviceTidStatsResult
  6. wifi_getApAssociatedDeviceStats
  7. wifi_getHalVersion
  8. wifi_factoryReset
  9. wifi_factoryResetRadios
  10. wifi_factoryResetRadio
  11. wifi_setLED
  12. wifi_init
  13. wifi_reset
  14. wifi_down
  15. wifi_createInitialConfigFiles
  16. wifi_getRadioCountryCode
  17. wifi_setRadioCountryCode
  18. wifi_pushCountryCode
  19. wifi_getATMCapable
  20. wifi_setATMEnable

• To see the API specification of WI-fI HAL please refer - Wi-Fi HAL APIs

...

All HAL functions prototypes and structure definitions are available in moca_hal.h file.

• MoCA HAL is used for the RDK-Broadband MoCA hardware hardware abstraction layer.
• An abstraction layer, mainly for interacting with MoCA driver.
• Some of the The APIs are : 
  1. moca_GetIfConfig
  2. moca_SetIfConfig
  3. moca_IfGetDynamicInfo
  4. moca_IfGetStaticInfo
  5. moca_IfGetStats
  6. moca_GetNumAssociatedDevices
  7. moca_IfGetExtCounter
  8. moca_IfGetExtAggrCounter
  9. moca_GetMocaCPEs
  10. moca_GetAssociatedDevices
  11. moca_FreqMaskToValue
  12. moca_HardwareEquipped
  13. moca_GetFullMeshRates
  14. moca_GetFlowStatistics
  15. moca_GetResetCount
  16. moca_setIfAcaConfig
  17. moca_getIfAcaConfig
  18. moca_cancelIfAca
  19. moca_getIfAcaStatus
  20. moca_getIfScmod
• To see the API specification of MoCA HAL please refer - MoCA HAL APIs

...

All HAL functions prototypes and structure definitions are available in mta_hal.h file. An MTA can deliver Home Phone service in addition to High Speed Internet.

• MTA HAL used for the RDK-Broadband hardware abstraction layer for Cable Modem.
• An abstraction layer, implemented to interact with MTA device.
• mta_hal.c file provides the function call prototypes and structure definitions used for the MTA hardware abstraction layer.
• Some of the APIs are : 
  1. mta_hal_InitDB
  2. mta_hal_GetDHCPInfo
  3. mta_hal_LineTableGetNumberOfEntries
  4. mta_hal_LineTableGetEntry
  5. mta_hal_TriggerDiagnostics
  6. mta_hal_GetServiceFlow
  7. mta_hal_DectGetEnable
  8. mta_hal_DectSetEnable.
  9. mta_hal_DectGetRegistrationMode
  10. mta_hal_DectSetRegistrationMode
  11. mta_hal_DectDeregisterDectHandset
  12. mta_hal_GetCalls
  13. mta_hal_GetDect
  14. mta_hal_GetDectPIN
  15. mta_hal_SetDectPIN
  16. mta_hal_GetHandsets
  17. mta_hal_GetCALLP
  18. mta_hal_GetDSXLogs
  19. mta_hal_GetDSXLogEnable
  20. mta_hal_SetDSXLogEnable
• To see the API specification of MTA HAL please refer - MTA HAL APIs 

...

• CM HAL is used for the RDK-Broadband hardware abstraction layer for Cable Modem.
• It provides interface that cable modem software developers can use to interface to RDK-B.
• Some of the APIs are : 
  1. cm_hal_InitDB
  2. docsis_InitDS
  3. docsis_InitUS
  4. docsis_getCMStatus
  5. docsis_GetDSChannel
  6. docsis_GetUsStatus
  7. docsis_GetUSChannel
  8. docsis_GetDOCSISInfo
  9. docsis_GetNumOfActiveTxChannels
  10. docsis_GetNumOfActiveRxChannels
  11. docsis_GetErrorCodewords
  12. docsis_SetMddIpModeOverride
  13. docsis_GetMddIpModeOverride
  14. docsis_GetUSChannelId
  15. docsis_SetUSChannelId
  16. docsis_GetDownFreq
  17. docsis_SetStartFreq
  18. docsis_GetDocsisEventLogItems
  19. cm_hal_GetDHCPInfo
  20. cm_hal_GetCPEList
• To see the API specification of CM HAL please refer - CM HAL APIs

...

• It provides implementation for Ethernet Switch Control.
• Based on how vendor exposes their driver capabilities in user space, the HAL API’s can be implemented in hal-ethsw-generic/git/source/ethsw/ccsp_hal_ethsw.c
• Some of the The APIs are : 
  1. CcspHalEthSwInit
  2. CcspHalEthSwGetPortStatus
  3. CcspHalEthSwGetPortCfg
  4. CcspHalEthSwSetPortCfg
  5. CcspHalEthSwGetPortAdminStatus
  6. CcspHalEthSwSetPortAdminStatus
  7. CcspHalEthSwSetAgingSpeed 
  8. CcspHalEthSwLocatePortByMacAddress
  9. CcspHalExtSw_getAssociatedDevice
  10. CcspHalExtSw_ethAssociatedDevice_callback_register
  11. CcspHalExtSw_getEthWanEnable
  12. CcspHalExtSw_setEthWanEnable
  13. CcspHalExtSw_getEthWanPort 
  14. CcspHalExtSw_setEthWanPort 
  15. GWP_RegisterEthWan_Callback 
  16. GWP_GetEthWanLinkStatus
  17. GWP_GetEthWanInterfaceName

• To see the API specification of Ethernet Switch HAL please refer - Ethernet Switch HAL APIs

...