i386/libsaio/nbp_cmd.h

   1 /*
   2  * Copyright (c) 1999-2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Portions Copyright (c) 1999-2003 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 2.0 (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
  25 #ifndef __LIBSAIO_NBP_CMD_H
  26 #define __LIBSAIO_NBP_CMD_H
  27
  28 #include <IOKit/IOTypes.h>
  29
  30 /*==========================================================================
  31  * NBP return status codes.
  32  */
  33 typedef enum {
  34     nbpStatusSuccess          = 0,
  35     nbpStatusFailed,
  36         nbpStatusInvalid,
  37 } nbpStatus_t;
  38
  39 /*==========================================================================
  40  * NBP commands codes.
  41  */
  42 typedef enum {
  43     nbpCommandTFTPReadFile    = 1,
  44     nbpCommandTFTPGetFileSize,
  45     nbpCommandUnloadBaseCode,
  46 } nbpCommandCode_t;
  47
  48 /*==========================================================================
  49  * NBP commands.
  50  */
  51 typedef struct {
  52     UInt32    status;         /* return code from NBP */
  53 } nbpCommandHeader_s;
  54
  55 typedef struct {
  56     UInt32   status;         /* return code from NBP */
  57     UInt8    filename[128];  /* name of file to be downloaded */
  58     UInt32   bufferSize;     /* size of the download buffer */
  59     UInt32   buffer;         /* physical address of the download buffer */
  60 } nbpCommandTFTPReadFile_s;
  61
  62 typedef struct {
  63     UInt32   status;         /* return code from NBP */
  64     UInt8    filename[128];  /* name of file to be downloaded */
  65     UInt32   filesize;       /* size of the file specified */
  66 } nbpCommandTFTPGetFileSize_s;
  67
  68 typedef struct {
  69     UInt32   status;         /* return code from NBP */
  70     UInt8    sname[64];      /* server name */
  71     UInt32   CIP;            /* client IP address */
  72     UInt32   SIP;            /* server IP address */
  73     UInt32   GIP;            /* gateway IP address */
  74 } nbpCommandGetNetworkInfo_s;
  75
  76 /*==========================================================================
  77  * An union of all NBP command structures.
  78  */
  79 typedef union {
  80         nbpCommandHeader_s           header;
  81         nbpCommandTFTPReadFile_s     tftpReadFile;
  82         nbpCommandTFTPGetFileSize_s  tftpFileSize;
  83 } nbpCommand_u;
  84
  85 #endif /* !__LIBSAIO_NBP_CMD_H */