BroadcomMailbox.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program is free software: 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 3 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBARCH_ARM_BROADCOM_MAILBOX_H
#define __LIBARCH_ARM_BROADCOM_MAILBOX_H
 
#include <Types.h>
#include <Macros.h>
#include <arm/ARMIO.h>
 
class BroadcomMailbox
{
  private:
 
    static const Address Base = 0xb000;
 
    static const uint ChannelMask = 0xf;
 
    enum Register
    {
        Read   = 0x0880,
        Status = 0x0898,
        Config = 0x089c,
        Write  = 0x08a0
    };
 
    enum StatusFlags
    {
        Full   = 0x80000000,
        Empty  = 0x40000000
    };
 
  public:
 
    enum Result
    {
        Success,
        IOError
    };
 
    enum Channel
    {
        PowerManagement = 0,
        FrameBuffer     = 1,
        VirtualUART     = 2,
        VCHIQ           = 3,
        LED             = 4,
        Button          = 5,
        TouchScreen     = 6,
        VCProperty      = 8,
        ARMProperty     = 9
    };
 
  public:
 
    BroadcomMailbox();
 
    Result initialize();
 
    Result read(Channel channel, u32 *message) const;
 
    Result write(Channel channel, u32 message);
 
  private:
 
    ARMIO m_io;
};
 
#endif /* __LIBARCH_ARM_BROADCOM_MAILBOX_H */