diff options
Diffstat (limited to 'mobicore/MobiCoreDriverLib/Kernel/Platforms/Generic/CMcKMod.h')
| -rw-r--r-- | mobicore/MobiCoreDriverLib/Kernel/Platforms/Generic/CMcKMod.h | 124 |
1 files changed, 124 insertions, 0 deletions
diff --git a/mobicore/MobiCoreDriverLib/Kernel/Platforms/Generic/CMcKMod.h b/mobicore/MobiCoreDriverLib/Kernel/Platforms/Generic/CMcKMod.h new file mode 100644 index 0000000..366fbbd --- /dev/null +++ b/mobicore/MobiCoreDriverLib/Kernel/Platforms/Generic/CMcKMod.h @@ -0,0 +1,124 @@ +/* + * Copyright (c) 2013 TRUSTONIC LIMITED + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * 3. Neither the name of the TRUSTONIC LIMITED nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; + * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, + * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR + * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** + * <t-base Driver Kernel Module Interface. + */ +#ifndef CMCKMOD_H_ +#define CMCKMOD_H_ + +#include <stdint.h> + +#include "McTypes.h" +#include "CKMod.h" + + +/** + * As this is also used by the ClientLib, we do not use exceptions. + */ +class CMcKMod : public CKMod +{ +public: + /** + * Map data. + * + * @param len + * @param pHandle + * @param pVirtAddr + * + * @return 0 if all went fine + * @return MC_DRV_ERR_KMOD_NOT_OPEN + * @return MC_DRV_ERR_KERNEL_MODULE or'ed with errno<<16 + */ + mcResult_t mapWsm(uint32_t len, + uint32_t *pHandle, + addr_t *pVirtAddr); + /** + * Map data. + * + * @param len + * @param pVirtAddr + * @param pMciReuse [in|out] set to true [in] for reusing MCI buffer + * is set to true [out] if MCI buffer has been reused + * @return 0 if all went fine + * @return MC_DRV_ERR_KMOD_NOT_OPEN + * @return MC_DRV_ERR_KERNEL_MODULE or'ed with errno<<16 + */ + mcResult_t mapMCI( + uint32_t len, + addr_t *pVirtAddr, + bool *pReuse); + + int read(addr_t buffer, uint32_t len); + + bool waitSSIQ(uint32_t *pCnt); + + int fcInit(uint32_t nqLength, + uint32_t mcpOffset, + uint32_t mcpLength); + + int fcInfo( + uint32_t extInfoId, + uint32_t *pState, + uint32_t *pExtInfo); + + int fcYield(void); + + int fcNSIQ(void); + + mcResult_t free(uint32_t handle, addr_t buffer, uint32_t len); + + mcResult_t registerWsmL2( + addr_t buffer, + uint32_t len, + uint32_t pid, + uint32_t *pHandle, + uint64_t *pPhysWsmL2); + + mcResult_t unregisterWsmL2(uint32_t handle); + + mcResult_t lockWsmL2(uint32_t handle); + + mcResult_t unlockWsmL2(uint32_t handle); + + mcResult_t cleanupWsmL2(void); + + uint64_t findWsmL2(uint32_t handle, int fd); + + mcResult_t findContiguousWsm(uint32_t handle, int fd, uint64_t *phys, uint32_t *len); + + mcResult_t setupLog(void); + + bool checkVersion(void); +}; + +typedef CMcKMod *CMcKMod_ptr; + +#endif // CMCKMOD_H_ |