summaryrefslogtreecommitdiff
path: root/include/drivers/nxp/nxp_timer.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/drivers/nxp/nxp_timer.h')
-rw-r--r--include/drivers/nxp/nxp_timer.h64
1 files changed, 64 insertions, 0 deletions
diff --git a/include/drivers/nxp/nxp_timer.h b/include/drivers/nxp/nxp_timer.h
new file mode 100644
index 0000000..cf3ec23
--- /dev/null
+++ b/include/drivers/nxp/nxp_timer.h
@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2018, ARM Limited and Contributors. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * Neither the name of ARM nor the names of its contributors may be used
+ * to endorse or promote products derived from this software without specific
+ * prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef __NXP_TIMER_H__
+#define __NXP_TIMER_H__
+
+/*
+ * Program nxp timer to fire an interrupt after `time_out_ms` milliseconds.
+ *
+ * Always return 0
+ */
+int nxp_timer_program(unsigned long time_out_ms);
+
+/*
+ * Cancel the currently programmed nxp timer interrupt
+ *
+ * Always return 0
+ */
+int nxp_timer_cancel(void);
+
+/*
+ * Initializes the nxp timer so that it can be used for programming
+ * timer interrupt.
+ * Must be called by the primary CPU only.
+ *
+ * Always return 0
+ */
+int nxp_timer_init(uintptr_t base_addr);
+
+/*
+ * Handler to acknowledge and de-activate the nxp timer interrupt
+ *
+ * Always return 0
+ */
+int nxp_timer_handler(void);
+
+#endif /* __NXP_TIMER_H__ */