summaryrefslogtreecommitdiffstats
path: root/bsps/arm/lpc176x/include/bsp/adc.h
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-12-23 18:18:56 +1100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2018-01-25 08:45:26 +0100
commit2afb22b7e1ebcbe40373ff7e0efae7d207c655a9 (patch)
tree44759efe9374f13200a97e96d91bd9a2b7e5ce2a /bsps/arm/lpc176x/include/bsp/adc.h
parentMAINTAINERS: Add myself to Write After Approval. (diff)
downloadrtems-2afb22b7e1ebcbe40373ff7e0efae7d207c655a9.tar.bz2
Remove make preinstall
A speciality of the RTEMS build system was the make preinstall step. It copied header files from arbitrary locations into the build tree. The header files were included via the -Bsome/build/tree/path GCC command line option. This has at least seven problems: * The make preinstall step itself needs time and disk space. * Errors in header files show up in the build tree copy. This makes it hard for editors to open the right file to fix the error. * There is no clear relationship between source and build tree header files. This makes an audit of the build process difficult. * The visibility of all header files in the build tree makes it difficult to enforce API barriers. For example it is discouraged to use BSP-specifics in the cpukit. * An introduction of a new build system is difficult. * Include paths specified by the -B option are system headers. This may suppress warnings. * The parallel build had sporadic failures on some hosts. This patch removes the make preinstall step. All installed header files are moved to dedicated include directories in the source tree. Let @RTEMS_CPU@ be the target architecture, e.g. arm, powerpc, sparc, etc. Let @RTEMS_BSP_FAMILIY@ be a BSP family base directory, e.g. erc32, imx, qoriq, etc. The new cpukit include directories are: * cpukit/include * cpukit/score/cpu/@RTEMS_CPU@/include * cpukit/libnetworking The new BSP include directories are: * bsps/include * bsps/@RTEMS_CPU@/include * bsps/@RTEMS_CPU@/@RTEMS_BSP_FAMILIY@/include There are build tree include directories for generated files. The include directory order favours the most general header file, e.g. it is not possible to override general header files via the include path order. The "bootstrap -p" option was removed. The new "bootstrap -H" option should be used to regenerate the "headers.am" files. Update #3254.
Diffstat (limited to 'bsps/arm/lpc176x/include/bsp/adc.h')
-rwxr-xr-xbsps/arm/lpc176x/include/bsp/adc.h60
1 files changed, 60 insertions, 0 deletions
diff --git a/bsps/arm/lpc176x/include/bsp/adc.h b/bsps/arm/lpc176x/include/bsp/adc.h
new file mode 100755
index 0000000000..34df8b7efd
--- /dev/null
+++ b/bsps/arm/lpc176x/include/bsp/adc.h
@@ -0,0 +1,60 @@
+/**
+ * @file adc.h
+ *
+ * @ingroup lpc176x
+ *
+ * @brief ADC library for the lpc176x bsp.
+ */
+
+/*
+ * Copyright (c) 2014 Taller Technologies.
+ *
+ * @author Diaz Marcos (marcos.diaz@tallertechnologies.com)
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.org/license/LICENSE.
+ */
+
+#ifndef LPC176X_ADC_H
+#define LPC176X_ADC_H
+
+#include <bsp.h>
+#include <bsp/common-types.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/**
+ * @brief Opens and initializes the ADC device.
+ *
+ * @param adc_number The ADC pin number to be initialized.
+ * @return RTEMS_SUCCESSFUL if the initialization was succesful,
+ * RTEMS_INVALID_NUMBER if wrong parameter.
+ */
+rtems_status_code adc_open( const lpc176x_pin_number pin_number );
+
+/**
+ * @brief Closes the ADC device.
+ *
+ * @return RTEMS_SUCCESSFUL if closed succesfully.
+ */
+rtems_status_code adc_close( void );
+
+/**
+ * @brief Starts a conversion, waits for it to finish and reads the value.
+ *
+ * @param pin_number The port to read the value.
+ * @param result The read result. (In a percentage between 0.0f and 1.0f).
+ */
+rtems_status_code adc_read(
+ const lpc176x_pin_number pin_number ,
+ float *const result
+);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif