Return to IOStubThread.h CVS log

Up to [Apple Darwin 0.x] / driverkit / Examples / IOStub

Annotation of driverkit/Examples/IOStub/IOStubThread.h, revision 1.1.1.1

1.1       root        1: /*
                      2:  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
                      3:  *
                      4:  * @APPLE_LICENSE_HEADER_START@
                      5:  * 
                      6:  * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
                      7:  * Reserved.  This file contains Original Code and/or Modifications of
                      8:  * Original Code as defined in and that are subject to the Apple Public
                      9:  * Source License Version 1.1 (the "License").  You may not use this file
                     10:  * except in compliance with the License.  Please obtain a copy of the
                     11:  * License at http://www.apple.com/publicsource and read it before using
                     12:  * this file.
                     13:  * 
                     14:  * The Original Code and all software distributed under the License are
                     15:  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
                     16:  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
                     17:  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
                     18:  * FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT.  Please see the
                     19:  * License for the specific language governing rights and limitations
                     20:  * under the License.
                     21:  * 
                     22:  * @APPLE_LICENSE_HEADER_END@
                     23:  */
                     24: /*     IOStubThread.h          1.0     02/07/91        (c) 1991 NeXT   
                     25:  *
                     26:  * IOStubThread.h - IOStub device thread support.
                     27:  *
                     28:  * HISTORY
                     29:  * 07-Feb-91    Doug Mitchell at NeXT
                     30:  *      Created.
                     31:  */
                     32: 
                     33: #ifndef        _IOSTUB_THREAD_
                     34: #define _IOSTUB_THREAD_
                     35: 
                     36: #import <driverkit/return.h>
                     37: #import <objc/objc.h>
                     38: #import <mach/cthreads.h>
                     39: #import <kernserv/queue.h>
                     40: #import "IOStub.h"
                     41: 
                     42: /*
                     43:  * Operations performed by IOStub's I/O thread.
                     44:  */
                     45: typedef enum {
                     46:        STUB_READ, 
                     47:        STUB_WRITE, 
                     48:        STUB_ZERO, 
                     49:        STUB_ABORT
                     50: } stub_cmd_t;
                     51: 
                     52: /*
                     53:  * Representation of one I/O. This is generated by the device's exported
                     54:  * methods and enqueued on IOQueue to be serviced by the I/O thread.
                     55:  */
                     56: typedef struct {
                     57: 
                     58:        stub_cmd_t      cmd;            /* op to perform */
                     59:        unsigned        offset;         /* block # */
                     60:        unsigned        bytesReq;       /* bytes to move */
                     61:        void            *buf;           /* where to r/w */
                     62:        unsigned        *bytesXfr;      /* bytes actually moved (RETURNED) */
                     63:        IOReturn        status;         /* result (RETURNED) */
                     64:        void            *pending;       /* if non-zero, async request; this is
                     65:                                         * used to ioComplete: the operation.
                     66:                                         */
                     67:        id              waitLock;       /* NXConditionLock. Sync I/O waits on 
                     68:                                         * this. */
                     69:        int             dirRead;        /* Written by command-specific code.
                     70:                                         * Specifies direction of data 
                     71:                                         * transfer. A hack which should go 
                     72:                                         * away with RO support. */
                     73:        queue_chain_t   link;           /* for linking on ioQueue */
                     74:        
                     75: } IOBuf_t;
                     76: 
                     77: @interface IOStub(Thread)
                     78: 
                     79: - (void)enqueueIoBuf : (IOBuf_t *)buf;
                     80: - (IOBuf_t *)dequeueIoBuf;
                     81: 
                     82: @end
                     83: 
                     84: 
                     85: extern void IOStub_thread(IOStub *stubId);
                     86: 
                     87: #endif _IOSTUB_THREAD_

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.