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