Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/hal/analogout_api.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dgabino 0:c76361bd82e8 1 /* mbed Microcontroller Library
dgabino 0:c76361bd82e8 2 * Copyright (c) 2006-2013 ARM Limited
dgabino 0:c76361bd82e8 3 *
dgabino 0:c76361bd82e8 4 * Licensed under the Apache License, Version 2.0 (the "License");
dgabino 0:c76361bd82e8 5 * you may not use this file except in compliance with the License.
dgabino 0:c76361bd82e8 6 * You may obtain a copy of the License at
dgabino 0:c76361bd82e8 7 *
dgabino 0:c76361bd82e8 8 * http://www.apache.org/licenses/LICENSE-2.0
dgabino 0:c76361bd82e8 9 *
dgabino 0:c76361bd82e8 10 * Unless required by applicable law or agreed to in writing, software
dgabino 0:c76361bd82e8 11 * distributed under the License is distributed on an "AS IS" BASIS,
dgabino 0:c76361bd82e8 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dgabino 0:c76361bd82e8 13 * See the License for the specific language governing permissions and
dgabino 0:c76361bd82e8 14 * limitations under the License.
dgabino 0:c76361bd82e8 15 */
dgabino 0:c76361bd82e8 16 #ifndef MBED_ANALOGOUT_API_H
dgabino 0:c76361bd82e8 17 #define MBED_ANALOGOUT_API_H
dgabino 0:c76361bd82e8 18
dgabino 0:c76361bd82e8 19 #include "device.h"
dgabino 0:c76361bd82e8 20
dgabino 0:c76361bd82e8 21 #if DEVICE_ANALOGOUT
dgabino 0:c76361bd82e8 22
dgabino 0:c76361bd82e8 23 #ifdef __cplusplus
dgabino 0:c76361bd82e8 24 extern "C" {
dgabino 0:c76361bd82e8 25 #endif
dgabino 0:c76361bd82e8 26
dgabino 0:c76361bd82e8 27 /** Analogout hal structure. dac_s is declared in the target's hal
dgabino 0:c76361bd82e8 28 */
dgabino 0:c76361bd82e8 29 typedef struct dac_s dac_t;
dgabino 0:c76361bd82e8 30
dgabino 0:c76361bd82e8 31 /**
dgabino 0:c76361bd82e8 32 * \defgroup hal_analogout Analogout hal functions
dgabino 0:c76361bd82e8 33 * @{
dgabino 0:c76361bd82e8 34 */
dgabino 0:c76361bd82e8 35
dgabino 0:c76361bd82e8 36 /** Initialize the analogout peripheral
dgabino 0:c76361bd82e8 37 *
dgabino 0:c76361bd82e8 38 * Configures the pin used by analogout.
dgabino 0:c76361bd82e8 39 * @param obj The analogout object to initialize
dgabino 0:c76361bd82e8 40 * @param pin The analogout pin name
dgabino 0:c76361bd82e8 41 */
dgabino 0:c76361bd82e8 42 void analogout_init(dac_t *obj, PinName pin);
dgabino 0:c76361bd82e8 43
dgabino 0:c76361bd82e8 44 /** Release the analogout object
dgabino 0:c76361bd82e8 45 *
dgabino 0:c76361bd82e8 46 * Note: This is not currently used in the mbed-drivers
dgabino 0:c76361bd82e8 47 * @param obj The analogout object
dgabino 0:c76361bd82e8 48 */
dgabino 0:c76361bd82e8 49 void analogout_free(dac_t *obj);
dgabino 0:c76361bd82e8 50
dgabino 0:c76361bd82e8 51 /** Set the output voltage, specified as a percentage (float)
dgabino 0:c76361bd82e8 52 *
dgabino 0:c76361bd82e8 53 * @param obj The analogin object
dgabino 0:c76361bd82e8 54 * @param value The floating-point output voltage to be set
dgabino 0:c76361bd82e8 55 */
dgabino 0:c76361bd82e8 56 void analogout_write(dac_t *obj, float value);
dgabino 0:c76361bd82e8 57
dgabino 0:c76361bd82e8 58 /** Set the output voltage, specified as unsigned 16-bit
dgabino 0:c76361bd82e8 59 *
dgabino 0:c76361bd82e8 60 * @param obj The analogin object
dgabino 0:c76361bd82e8 61 * @param value The unsigned 16-bit output voltage to be set
dgabino 0:c76361bd82e8 62 */
dgabino 0:c76361bd82e8 63 void analogout_write_u16(dac_t *obj, uint16_t value);
dgabino 0:c76361bd82e8 64
dgabino 0:c76361bd82e8 65 /** Read the current voltage value on the pin
dgabino 0:c76361bd82e8 66 *
dgabino 0:c76361bd82e8 67 * @param obj The analogin object
dgabino 0:c76361bd82e8 68 * @return A floating-point value representing the current voltage on the pin,
dgabino 0:c76361bd82e8 69 * measured as a percentage
dgabino 0:c76361bd82e8 70 */
dgabino 0:c76361bd82e8 71 float analogout_read(dac_t *obj);
dgabino 0:c76361bd82e8 72
dgabino 0:c76361bd82e8 73 /** Read the current voltage value on the pin, as a normalized unsigned 16bit value
dgabino 0:c76361bd82e8 74 *
dgabino 0:c76361bd82e8 75 * @param obj The analogin object
dgabino 0:c76361bd82e8 76 * @return An unsigned 16-bit value representing the current voltage on the pin
dgabino 0:c76361bd82e8 77 */
dgabino 0:c76361bd82e8 78 uint16_t analogout_read_u16(dac_t *obj);
dgabino 0:c76361bd82e8 79
dgabino 0:c76361bd82e8 80 /**@}*/
dgabino 0:c76361bd82e8 81
dgabino 0:c76361bd82e8 82 #ifdef __cplusplus
dgabino 0:c76361bd82e8 83 }
dgabino 0:c76361bd82e8 84 #endif
dgabino 0:c76361bd82e8 85
dgabino 0:c76361bd82e8 86 #endif
dgabino 0:c76361bd82e8 87
dgabino 0:c76361bd82e8 88 #endif