/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef __MICROPY_INCLUDED_ATMEL_SAMD_PIN_H__
#define __MICROPY_INCLUDED_ATMEL_SAMD_PIN_H__

// Don't reorder these includes because they are dependencies of adc_feature.h.
// They should really be included by adc_feature.h.
#include "compiler.h"
#include "asf/sam0/drivers/system/clock/gclk.h"
#include "asf/sam0/utils/cmsis/samd21/include/component/adc.h"
#include "asf/sam0/drivers/adc/adc_sam_d_r/adc_feature.h"

// This macro is used to simplify pin definition in boards/<board>/pins.c
#define PIN_TWO_TIMERS(p_name, p_has_adc, p_adc_input, p_primary_tc, p_primary_tcc, \
  p_primary_channel, p_primary_wave_output, p_primary_pin, p_primary_mux, \
  p_secondary_tc, p_secondary_tcc, p_secondary_channel, p_secondary_wave_output, \
  p_secondary_pin, p_secondary_mux) \
const pin_obj_t pin_## p_name = { \
    { &pin_type }, \
    .name = MP_QSTR_ ## p_name, \
    .pin = (PIN_## p_name), \
    .has_adc = p_has_adc, \
    .adc_input = p_adc_input, \
    .primary_timer = { \
      .tc = p_primary_tc, \
      .tcc = p_primary_tcc, \
      .channel = p_primary_channel, \
      .wave_output = p_primary_wave_output, \
      .pin = p_primary_pin, \
      .mux = p_primary_mux \
    }, \
    .secondary_timer = { \
      .tc = p_secondary_tc, \
      .tcc = p_secondary_tcc, \
      .channel = p_secondary_channel, \
      .wave_output = p_secondary_wave_output, \
      .pin = p_secondary_pin, \
      .mux = p_secondary_mux \
    } \
}

#define PIN_NO_TIMERS_(p_name, p_has_adc, p_adc_input) \
 PIN_TWO_TIMERS(p_name, p_has_adc, p_adc_input, \
   0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)

#define PIN_ONE_TIMER_(p_name, p_has_adc, p_adc_input, p_primary_tcc, \
  p_primary_tc, p_primary_channel, p_primary_wave_output, \
  p_primary_pin, p_primary_mux) \
  PIN_TWO_TIMERS(p_name, p_has_adc, p_adc_input, p_primary_tcc, p_primary_tc, \
    p_primary_channel, p_primary_wave_output, p_primary_pin, p_primary_mux, \
    0, 0, 0, 0, 0, 0)

#define NO_ADC_INPUT (0)

#include "mpconfigport.h"

#include "py/obj.h"

typedef struct {
  Tc *const tc;
  Tcc *const tcc;
  uint8_t channel;
  uint8_t wave_output;
  uint32_t pin;
  uint32_t mux;
} pin_timer_t;

typedef struct {
  mp_obj_base_t base;
  qstr name;
  uint32_t pin;
  bool has_adc;
  enum adc_positive_input adc_input;
  pin_timer_t primary_timer;
  pin_timer_t secondary_timer;
} pin_obj_t;

extern const mp_obj_type_t pin_type;

typedef struct {
  const char *name;
  const pin_obj_t *pin;
} pin_named_pin_t;

extern const pin_named_pin_t pin_board_pins[];
extern const pin_named_pin_t pin_cpu_pins[];

//extern pin_map_obj_t pin_map_obj;

typedef struct {
    mp_obj_base_t base;
    qstr name;
    const pin_named_pin_t *named_pins;
} pin_named_pins_obj_t;

extern const mp_obj_type_t pin_board_pins_obj_type;
extern const mp_obj_type_t pin_cpu_pins_obj_type;

extern const mp_obj_dict_t pin_cpu_pins_locals_dict;
extern const mp_obj_dict_t pin_board_pins_locals_dict;

MP_DECLARE_CONST_FUN_OBJ(pin_init_obj);

void pin_init0(void);
uint32_t pin_get_mode(const pin_obj_t *pin);
uint32_t pin_get_pull(const pin_obj_t *pin);
uint32_t pin_get_af(const pin_obj_t *pin);
const pin_obj_t *pin_find(mp_obj_t user_obj);
const pin_obj_t *pin_find_named_pin(const mp_obj_dict_t *named_pins, mp_obj_t name);

#endif // __MICROPY_INCLUDED_ATMEL_SAMD_PIN_H__