NSError+IOReturn.m   [plain text]

//
//  NSError+IOReturn.m
//  HID
//
//  Created by Matty on 7/10/18.
//

#import <Foundation/Foundation.h>
#import "NSError+IOReturn.h"
#import <IOKit/IOReturn.h>

@implementation NSError (IOReturn)

+ (NSError *)errorWithIOReturn:(IOReturn)code
{
    const NSDictionary *errors = @{
        @(kIOReturnSuccess):            @"success",
        @(kIOReturnError):              @"general error",
        @(kIOReturnNoMemory):           @"memory allocation error",
        @(kIOReturnNoResources):        @"resource shortage",
        @(kIOReturnIPCError):           @"Mach IPC failure",
        @(kIOReturnNoDevice):           @"no such device",
        @(kIOReturnNotPrivileged):      @"privilege violation",
        @(kIOReturnBadArgument):        @"invalid argument",
        @(kIOReturnLockedRead):         @"device is read locked",
        @(kIOReturnLockedWrite):        @"device is write locked",
        @(kIOReturnExclusiveAccess):    @"device is exclusive access",
        @(kIOReturnBadMessageID):       @"bad IPC message ID",
        @(kIOReturnUnsupported):        @"unsupported function",
        @(kIOReturnVMError):            @"virtual memory error",
        @(kIOReturnInternalError):      @"internal driver error",
        @(kIOReturnIOError):            @"I/O error",
        @(kIOReturnCannotLock):         @"cannot acquire lock",
        @(kIOReturnNotOpen):            @"device is not open",
        @(kIOReturnNotReadable):        @"device is not readable",
        @(kIOReturnNotWritable):        @"device is not writeable",
        @(kIOReturnNotAligned):         @"alignment error",
        @(kIOReturnBadMedia):           @"media error",
        @(kIOReturnStillOpen):          @"device is still open",
        @(kIOReturnRLDError):           @"rld failure",
        @(kIOReturnDMAError):           @"DMA failure",
        @(kIOReturnBusy):               @"device is busy",
        @(kIOReturnTimeout):            @"I/O timeout",
        @(kIOReturnOffline):            @"device is offline",
        @(kIOReturnNotReady):           @"device is not ready",
        @(kIOReturnNotAttached):        @"device/channel is not attached",
        @(kIOReturnNoChannels):         @"no DMA channels available",
        @(kIOReturnNoSpace):            @"no space for data",
        @(kIOReturnPortExists):         @"device port already exists",
        @(kIOReturnCannotWire):         @"cannot wire physical memory",
        @(kIOReturnNoInterrupt):        @"no interrupt attached",
        @(kIOReturnNoFrames):           @"no DMA frames enqueued",
        @(kIOReturnMessageTooLarge):    @"message is too large",
        @(kIOReturnNotPermitted):       @"operation is not permitted",
        @(kIOReturnNoPower):            @"device is without power",
        @(kIOReturnNoMedia):            @"media is not present",
        @(kIOReturnUnformattedMedia):   @"media is not formatted",
        @(kIOReturnUnsupportedMode):    @"unsupported mode",
        @(kIOReturnUnderrun):           @"data underrun",
        @(kIOReturnOverrun):            @"data overrun",
        @(kIOReturnDeviceError):        @"device error",
        @(kIOReturnNoCompletion):       @"no completion routine",
        @(kIOReturnAborted):            @"operation was aborted",
        @(kIOReturnNoBandwidth):        @"bus bandwidth would be exceeded",
        @(kIOReturnNotResponding):      @"device is not responding",
        @(kIOReturnInvalid):            @"unanticipated driver error",
      };
    
    NSString *errorText = errors[@(code)];
    
    if (!errorText) {
        errorText = [NSString stringWithFormat:@"0x%x unknown", code];
    }
    
    NSDictionary *userInfo = @{ NSLocalizedDescriptionKey : errorText };
    
    return [NSError errorWithDomain:@"HIDFramework"
                               code:code
                           userInfo:userInfo];
}

@end