diff options
Diffstat (limited to 'src/include/usr/mmio/mmio.H')
| -rw-r--r-- | src/include/usr/mmio/mmio.H | 39 |
1 files changed, 6 insertions, 33 deletions
diff --git a/src/include/usr/mmio/mmio.H b/src/include/usr/mmio/mmio.H index e340e29e4..b0a9c522e 100644 --- a/src/include/usr/mmio/mmio.H +++ b/src/include/usr/mmio/mmio.H @@ -22,50 +22,23 @@ /* permissions and limitations under the License. */ /* */ /* IBM_PROLOG_END_TAG */ -#ifndef __MMIO_H -#define __MMIO_H +#ifndef __USR_MMIO_MMIO_H +#define __USR_MMIO_MMIO_H /** @file mmio.H - * @brief Provides the interfaces to perform a MMIO operation + * @brief Provides the interface to initialize MMIO operations * */ namespace MMIO { /** * @brief Memory map OCMBs. - * This function maps OCMB memory and registers into Hostboot virtual memory.. + * This function maps OCMB memory and registers it into Hostboot virtual memory. * + * @return nullptr on success, valid error log(errlHndl_t) if an error occurred */ -void mmioSetup(); +errlHndl_t mmioSetup(); -/** - * @brief Complete the MMIO operation. - * This function performs read or write operations on OCMBs by accessing - * virtual memory that was previously memory mapped to the OCMBs. - * It follows a pre-defined function prototype in order to be registered - * with the device driver framework. - * - * @param[in] i_opType Operation type, see driverif.H - * @param[in] i_target MMIO target - * @param[in/out] io_buffer Read: Pointer to output data storage - * Write: Pointer to input data storage - * @param[in/out] io_buflen Input: Read: size of data to read (in bytes) - * Write: Size of data to write - * Output: Read: Size of output data - * Write: Size of data written - * @param[in] i_accessType Access type - * @param[in] i_args This is an argument list for DD framework. - * In this function, there are two arguments, - * the offset (bytes) into the device, and the number - * of bytes to read at a time (device limitation). - * @return errlHndl_t - */ -errlHndl_t mmioPerformOp(DeviceFW::OperationType i_opType, - TARGETING::TargetHandle_t i_target, - void* io_buffer, - size_t& io_buflen, - int64_t i_accessType, - va_list i_args); }; // End namespace #endif |
