/**
 * Copyright 2016-2023
 * 
 * Bernd-Christian Renner, and
 * Hamburg University of Technology (TUHH).
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


#ifndef HAL_TXAMP_H_
#define HAL_TXAMP_H_

#include <stdint.h>
#include <stdbool.h>

#include "fixpoint.h"


void
txamp_init(void);


bool
txamp_setGainLevel(uint8_t lvl);


uint8_t
txamp_getGainLevel(void);


uint8_t
txamp_getNumGainLevels(void);


/*
 * enable txamp circuitry, do not connect hydrophones to TXAMP
 */
void
txamp_enable(void);


/*
 * disable txamp circuitry and connect hydrophone to rxamp
 * side effect: disconnect output (should be done in HW as well)
 */
void
txamp_disable(void);


/*
 * connect output stage of txamp to hydrophone
 */
void
txamp_connectOutput(void);


/*
 * disconnect output stage of txamp from hydrophone
 */
void
txamp_disconnectOutput(void);


#endif  /* HAL_TXAMP_H_ */