i386/include/undi.h

a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#ifndef _UNDI_H
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define _UNDI_H
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** @file
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * UNDI driver
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncFILE_LICENCE ( GPL2_OR_LATER );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#ifndef ASSEMBLY
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <ipxe/device.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <pxe_types.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** An UNDI device
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This structure is used by assembly code as well as C; do not alter
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * this structure without editing pxeprefix.S to match.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstruct undi_device {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** PXENV+ structure address */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    SEGOFF16_t pxenv;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** !PXE structure address */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    SEGOFF16_t ppxe;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** Entry point */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    SEGOFF16_t entry;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** Free base memory after load */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    UINT16_t fbms;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** Free base memory prior to load */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    UINT16_t restore_fbms;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** PCI bus:dev.fn, or @c UNDI_NO_PCI_BUSDEVFN */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    UINT16_t pci_busdevfn;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** ISAPnP card select number, or @c UNDI_NO_ISAPNP_CSN */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    UINT16_t isapnp_csn;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** ISAPnP read port, or @c UNDI_NO_ISAPNP_READ_PORT */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    UINT16_t isapnp_read_port;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** PCI vendor ID
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     * Filled in only for the preloaded UNDI device by pxeprefix.S
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    UINT16_t pci_vendor;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** PCI device ID
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     * Filled in only for the preloaded UNDI device by pxeprefix.S
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    UINT16_t pci_device;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** Flags
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     * This is the bitwise OR of zero or more UNDI_FL_XXX
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     * constants.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    UINT16_t flags;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** Generic device */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    struct device dev;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    /** Driver-private data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     * Use undi_set_drvdata() and undi_get_drvdata() to access this
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     * field.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync     */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    void *priv;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync} __attribute__ (( packed ));
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Set UNDI driver-private data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v undi      UNDI device
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v priv      Private data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline void undi_set_drvdata ( struct undi_device *undi, void *priv ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    undi->priv = priv;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Get UNDI driver-private data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v undi      UNDI device
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret priv        Private data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline void * undi_get_drvdata ( struct undi_device *undi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return undi->priv;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#endif /* ASSEMBLY */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** PCI bus:dev.fn field is invalid */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define UNDI_NO_PCI_BUSDEVFN 0xffff
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** ISAPnP card select number field is invalid */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define UNDI_NO_ISAPNP_CSN 0xffff
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** ISAPnP read port field is invalid */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define UNDI_NO_ISAPNP_READ_PORT 0xffff
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** UNDI flag: START_UNDI has been called */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define UNDI_FL_STARTED 0x0001
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** UNDI flag: UNDI_STARTUP and UNDI_INITIALIZE have been called */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define UNDI_FL_INITIALIZED 0x0002
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** UNDI flag: keep stack resident */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define UNDI_FL_KEEP_ALL 0x0004
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#endif /* _UNDI_H */