ksz8851.h

Go to the documentation of this file.

#ifndef KSZ8851_H_INCLUDED
#define KSZ8851_H_INCLUDED
/**********************************************************************/
/*
 * Copyright (c) 2014-2016, Jetro AS
 * 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. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``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 AUTHOR 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.
 *
 * This file is part of the EVE platform.
 */

/**
 * \file
 * @brief Driver for KSZ8851 Ethernet chip.
 *
 * @author DT, Jetro AS
 */ /******************************************************************/

#include <sys/process.h>
#include <core/mwork.h>
#include <net/uip-fw.h>
#include <net/uip.h>
#include <net/common/ep.h>
#include <dev/spi.h>

/**
 * \defgroup ksz8851 KSZ8851 ethernet chip driver
 * \ingroup extdrv
 * \{
 *
 */

struct ksz8851_t;

enum ksz8851_opstate_t {
  KSZ8851_OFF,
  KSZ8851_INIT,
  KSZ8851_DISCONNECTED,
  KSZ8851_ON,
};

enum ksz8851_leds_mode_t {
  KSZ8851_LEDS_MODE_LINK_ACT_100BT,
  KSZ8851_LEDS_MODE_LINK_ACT,
  KSZ8851_LEDS_MODE_OFF,
};

enum ksz8851_leds_test_t {
  KSZ8851_LEDS_NO_TEST,
  KSZ8851_LEDS_TEST_OFF,
  KSZ8851_LEDS_TEST_GREEN,
  KSZ8851_LEDS_TEST_BOTH,
};

struct ksz8851_xfer_t {
  void *Data;
  int ByteCount;
  ep_if_xfer_cb_t Callback;
};

struct ksz8851_events_t {
  struct process *MonitorProcess;
  process_event_t EventMedia;
};

struct ksz8851_state_t {
  struct mwork_t Work;
  struct process Process;
  struct uip_fw_netif Netif;
  uip_lladdr_t MacAddr;
  const struct ksz8851_t *Module;
  const struct ksz8851_events_t *Events;
  enum ksz8851_opstate_t Opstate;
  struct ksz8851_xfer_t RxXfer;
  struct ksz8851_xfer_t TxXfer;
  uint16_t RxFrameCount;
  uint16_t Ier;
  bool PowerSave;
};

struct ksz8851_t {
  struct ksz8851_state_t *State;
  const struct spi_t *Spi;
  struct spi_cs_t SpiCs;
  uint32_t SpiBaudrate;
  uint8_t IrqPin;
  uint8_t ResetPin;
  bool ResetActiveHigh;
  bool PowerSaveDefault;
};

void EthInit(const struct ksz8851_t *Module, const struct ksz8851_events_t *Events);
void EthPowerSave(const struct ksz8851_t *Module, bool IsOn);
void EthSetLedsMode(const struct ksz8851_t *Module, enum ksz8851_leds_mode_t Mode);
void EthDoLedsTest(const struct ksz8851_t *Module, enum ksz8851_leds_test_t Test);
void EthRead(struct process *Process, void *Data, int ByteCount, ep_if_xfer_cb_t Callback);
void EthWrite(struct process *Process, void *Data, int ByteCount, ep_if_xfer_cb_t Callback);
void EthAbortTransfer(struct process *Process);
void EthInterruptCb(const struct ksz8851_t *Module);

static inline bool EthCableConnected(const struct ksz8851_t *Module)
{
  return (Module->State->Opstate == KSZ8851_ON);
}

/** \} */

#endif /* KSZ8851_H_INCLUDED */