DellRbu.h

Go to the documentation of this file.

// vim:expandtab:autoindent:tabstop=4:shiftwidth=4:filetype=c:
/*
 * Copyright (C) 2005 Dell Inc.
 *  by Michael Brown <Michael_E_Brown@dell.com>
 * Licensed under the Open Software License version 2.1 
 * 
 * Alternatively, you can redistribute it and/or modify 
 * it under the terms of the GNU General Public License as published 
 * by the Free Software Foundation; either version 2 of the License, 
 * or (at your option) any later version.

 * This program is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 * See the GNU General Public License for more details.
 */


#ifndef RBU_H
#define RBU_H

// compat header should always be first header, if system headers included
#include "smbios/compat.h"

#include <string>

// types.h should be first user-defined header.
#include "smbios/types.h"
#include "smbios/IFactory.h"
#include "smbios/IException.h"

// abi_prefix should be last header included before declarations
#include "smbios/config/abi_prefix.hpp"


namespace rbu
{
    DECLARE_EXCEPTION( RbuException );
    DECLARE_EXCEPTION_EX( RbuNotSupported, rbu, RbuException );
    DECLARE_EXCEPTION_EX( InvalidHdrFile, rbu, RbuException );
    DECLARE_EXCEPTION_EX( UnsupportedSystemForHdrFile, rbu, RbuException );
    DECLARE_EXCEPTION_EX( HdrFileIOError, rbu, RbuException );
    DECLARE_EXCEPTION_EX( RbuDriverIOError, rbu, RbuException );

    typedef enum { pt_any, pt_mono, pt_packet, pt_init } packet_type;
    // rbu_linux_v0: Linux 2.4
    // rbu_linux_v1: 2.6 dkms
    // rbu_linux_v2: 2.6.14+
    typedef enum { rbu_unsupported, rbu_linux_v0, rbu_linux_v1, rbu_linux_v2 } driver_type;

    const int SYSID_OVERRIDE = 1;
    const int BIOSVER_OVERRIDE = 2;

    // forward decls
    class IRbuHdr;


    class RbuFactory : public virtual factory::IFactory
    {
    public:

        static RbuFactory *getFactory();
        virtual ~RbuFactory() throw();


        virtual IRbuHdr *makeNew(std::string filename) = 0;
    protected:
        RbuFactory();
    };


    class IRbuHdr
    {
    public:
        // CONSTRUCTORS, DESTRUCTOR, and ASSIGNMENT
        IRbuHdr();
        // Interface class: no default or copy constructor
        virtual ~IRbuHdr ();

        //output table information.
        virtual std::ostream & streamify(std::ostream & cout ) const = 0;

        virtual std::string getBiosVersion() const = 0;
        virtual void getHdrVersion(unsigned int &major, unsigned int &minor) const = 0;
        virtual const u32 *getSystemIdList() const = 0;
        virtual void doUpdate() const = 0;
        virtual FILE *getFh() const = 0;

    private:
        explicit IRbuHdr(const IRbuHdr &); 
        void operator =( const IRbuHdr & ); 
    };

    std::ostream & operator << (std::ostream & cout, const IRbuHdr & item);


    void cancelDellBiosUpdate();


    bool checkSystemId(const IRbuHdr &hdr, u16 sysId );


    void dellBiosUpdate(const IRbuHdr &hdr, packet_type force_type);


    int compareBiosVersion(std::string ver1, std::string ver2);

}

// always should be last thing in header file
#include "smbios/config/abi_suffix.hpp"

#endif  /* RBU_H */

---