diff options
author | alexander <alexander.efremov@arm.com> | 2022-02-10 16:15:54 +0000 |
---|---|---|
committer | alexander <alexander.efremov@arm.com> | 2022-02-10 18:04:42 +0000 |
commit | 31ae9f09bb3535975595e999fbc7baca889e46e8 (patch) | |
tree | 71f0cadc2620b9d18e474e5d40eda7b3d30a8ce4 /source/hal/include/data_acq.h | |
parent | 3107aa2152de9be8317e62da1d0327bcad6552e2 (diff) | |
download | ml-embedded-evaluation-kit-31ae9f09bb3535975595e999fbc7baca889e46e8.tar.gz |
MLECO-2682: CMake and source refactoring.
MLECO-2930: logging macros were extracted from hal.h and used separately around the code.
MLECO-2931: arm_math lib introduced, cmsis-dsp removed from top level linkage.
MLECO-2915: platform related post-build steps.
Change-Id: Id718884e22f262a5c070ded3f3f5d4b048820147
Signed-off-by: alexander <alexander.efremov@arm.com>
Diffstat (limited to 'source/hal/include/data_acq.h')
-rw-r--r-- | source/hal/include/data_acq.h | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/source/hal/include/data_acq.h b/source/hal/include/data_acq.h new file mode 100644 index 0000000..965fbe5 --- /dev/null +++ b/source/hal/include/data_acq.h @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2021 Arm Limited. All rights reserved. + * SPDX-License-Identifier: Apache-2.0 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#ifndef DATA_ACQ_H +#define DATA_ACQ_H + +/** + * This file is the top level abstraction for the data acquisition module. + **/ +#include <stdint.h> + +/* Structure to encompass the data acquisition module and it's methods. */ +typedef struct data_acquisition_module { + int inited; /**< initialised or not. */ + char system_name[8]; /**< name(s) of the channel in use. */ + int (* system_init)(void); /**< channel initialisation function. */ + + /* Function to go and check if there are any events that require handling. */ + int (* get_input)(char *user_input, int size); +} data_acq_module; + +/** + * @brief Initialise the data acquisition channel: goes and + * sets the required channel up for usage. + * @param[in,out] module Pointer to a pre-allocated data + * acquisition structure object. + * @return 0 if successful, error code otherwise. + **/ +int data_acq_channel_init(data_acq_module *module); + +/** + * @brief Releases the data acquisition channel. + * @param[in,out] module Pointer to a pre-allocated data + * acquisition structure object. + * @return 0 if successful, error code otherwise. + **/ +int data_acq_channel_release(data_acq_module *module); + +#endif /* DATA_ACQ_H */ |