i386/libsaio/nbp_cmd.h

   1 /*
   2  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25
  26 #ifndef __LIBSAIO_NBP_CMD_H
  27 #define __LIBSAIO_NBP_CMD_H
  28
  29 #include <IOKit/IOTypes.h>
  30
  31 /*==========================================================================
  32  * NBP return status codes.
  33  */
  34 typedef enum {
  35     nbpStatusSuccess          = 0,
  36     nbpStatusFailed,
  37         nbpStatusInvalid,
  38 } nbpStatus_t;
  39
  40 /*==========================================================================
  41  * NBP commands codes.
  42  */
  43 typedef enum {
  44     nbpCommandTFTPReadFile    = 1,
  45     nbpCommandTFTPGetFileSize,
  46     nbpCommandUnloadBaseCode,
  47 } nbpCommandCode_t;
  48
  49 /*==========================================================================
  50  * NBP commands.
  51  */
  52 typedef struct {
  53     UInt32    status;         /* return code from NBP */
  54 } nbpCommandHeader_s;
  55
  56 typedef struct {
  57     UInt32   status;         /* return code from NBP */
  58     UInt8    filename[128];  /* name of file to be downloaded */
  59     UInt32   bufferSize;     /* size of the download buffer */
  60     UInt32   buffer;         /* physical address of the download buffer */
  61 } nbpCommandTFTPReadFile_s;
  62
  63 typedef struct {
  64     UInt32   status;         /* return code from NBP */
  65     UInt8    filename[128];  /* name of file to be downloaded */
  66     UInt32   filesize;       /* size of the file specified */
  67 } nbpCommandTFTPGetFileSize_s;
  68
  69 typedef struct {
  70     UInt32   status;         /* return code from NBP */
  71     UInt8    sname[64];      /* server name */
  72     UInt32   CIP;            /* client IP address */
  73     UInt32   SIP;            /* server IP address */
  74     UInt32   GIP;            /* gateway IP address */
  75 } nbpCommandGetNetworkInfo_s;
  76
  77 /*==========================================================================
  78  * An union of all NBP command structures.
  79  */
  80 typedef union {
  81         nbpCommandHeader_s           header;
  82         nbpCommandTFTPReadFile_s     tftpReadFile;
  83         nbpCommandTFTPGetFileSize_s  tftpFileSize;
  84 } nbpCommand_u;
  85
  86 #endif /* !__LIBSAIO_NBP_CMD_H */