alexander | 3c79893 | 2021-03-26 21:42:19 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright (c) 2021 Arm Limited. All rights reserved. |
| 3 | * SPDX-License-Identifier: Apache-2.0 |
| 4 | * |
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | * you may not use this file except in compliance with the License. |
| 7 | * You may obtain a copy of the License at |
| 8 | * |
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | * |
| 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | * See the License for the specific language governing permissions and |
| 15 | * limitations under the License. |
| 16 | */ |
| 17 | #ifndef DATA_ACQ_H |
| 18 | #define DATA_ACQ_H |
| 19 | |
| 20 | /** |
| 21 | * This file is the top level abstraction for the data acquisition module. |
| 22 | **/ |
| 23 | #include <stdint.h> |
| 24 | |
| 25 | /* Structure to encompass the data acquisition module and it's methods. */ |
| 26 | typedef struct data_acquisition_module { |
| 27 | int inited; /**< initialised or not. */ |
| 28 | char system_name[8]; /**< name(s) of the channel in use. */ |
| 29 | int (* system_init)(void); /**< channel initialisation function. */ |
| 30 | |
| 31 | /* Function to go and check if there are any events that require handling. */ |
| 32 | int (* get_input)(char *user_input, int size); |
| 33 | } data_acq_module; |
| 34 | |
| 35 | /** |
| 36 | * @brief Initialise the data acquisition channel: goes and |
| 37 | * sets the required channel up for usage. |
| 38 | * @param[in,out] module Pointer to a pre-allocated data |
| 39 | * acquisition structure object. |
| 40 | * @return 0 if successful, error code otherwise. |
| 41 | **/ |
| 42 | int data_acq_channel_init(data_acq_module *module); |
| 43 | |
| 44 | /** |
| 45 | * @brief Releases the data acquisition channel. |
| 46 | * @param[in,out] module Pointer to a pre-allocated data |
| 47 | * acquisition structure object. |
| 48 | * @return 0 if successful, error code otherwise. |
| 49 | **/ |
| 50 | int data_acq_channel_release(data_acq_module *module); |
| 51 | |
| 52 | #endif /* DATA_ACQ_H */ |