1 /* 2 * Copyright (c) 2019 Apple Computer, Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 29 #ifndef _IOKIT_PLATFORM_IOPLATFORMIO_H 30 #define _IOKIT_PLATFORM_IOPLATFORMIO_H 31 32 extern "C" { 33 #include <kern/kern_types.h> 34 } 35 36 #include <IOKit/IOService.h> 37 38 /*! 39 * @class IOPlatformIO 40 * @abstract The base class for platform I/O drivers, such as AppleARMIO. 41 */ 42 class IOPlatformIO : public IOService 43 { 44 OSDeclareAbstractStructors(IOPlatformIO); 45 46 public: 47 virtual bool start(IOService * provider) APPLE_KEXT_OVERRIDE; 48 49 /*! 50 * @function handlePlatformError 51 * @abstract Handler for platform-defined errors. 52 * @discussion If the CPU reports an error that XNU does not know how 53 * to handle, such as a parity error or SError, XNU will 54 * invoke this method if there is an IOPlatformIO 55 * driver loaded. 56 * @param far Fault address provided by the CPU, if any. 57 * @result true if the exception was handled, false if not. 58 */ 59 virtual bool handlePlatformError(vm_offset_t far) = 0; 60 }; 61 62 #endif /* ! _IOKIT_PLATFORM_IOPLATFORMIO_H */ 63