Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/hal/analogout_api.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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