pl031.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_PL031_H
#define _ULTIBO_PL031_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/rtc.h"

#define PL031_RTC_DESCRIPTION   "ARM PrimeCell PL031 Real Time Clock" 
 
#define PL031_MIN_TIME  TIME_TICKS_TO_1970 
#define PL031_MAX_TIME  137919572470000000 

#define PL031_RTC_CR_EN (1 << 0) 

#define PL031_RTC_IMSC_INTR_SET (1 << 0)
#define PL031_RTC_IMSC_INTR_CLEAR   (0 << 0)

#define PL031_RTC_RIS_INTR  (1 << 0)

#define PL031_RTC_MIS_INTR  (1 << 0)

#define PL031_RTC_ICR_INTR  (1 << 0)

typedef struct _PL031_RTC_REGISTERS PL031_RTC_REGISTERS;
struct _PL031_RTC_REGISTERS
{
    uint32_t dr; 
    uint32_t mr; 
    uint32_t lr; 
    uint32_t cr; 
    uint32_t imsc; 
    uint32_t ris; 
    uint32_t mis; 
    uint32_t icr; 
};
 
 
typedef struct _PL031_RTC PL031_RTC;
struct _PL031_RTC
{
    // RTC Properties
    RTC_DEVICE rtc;
    // PL031 Properties
    uint32_t irq;
    PL031_RTC_REGISTERS *registers; 
    // Statistics Properties
    uint32_t interruptcount; 
};


RTC_DEVICE * STDCALL pl031_rtc_create(size_t address, char *name, uint32_t irq);

uint32_t STDCALL pl031_rtc_destroy(RTC_DEVICE *rtc);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_PL031_H