/* $NetBSD: ar5312_board.c,v 1.5 2015/06/09 22:50:50 matt Exp $ */
/*
* Copyright (c) 2006 Urbana-Champaign Independent Media Center.
* Copyright (c) 2006 Garrett D'Amore.
* All rights reserved.
*
* This code was written by Garrett D'Amore for the Champaign-Urbana
* Community Wireless Network Project.
*
* 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. All advertising materials mentioning features or use of this
*    software must display the following acknowledgements:
*      This product includes software developed by the Urbana-Champaign
*      Independent Media Center.
*      This product includes software developed by Garrett D'Amore.
* 4. Urbana-Champaign Independent Media Center's name and Garrett
*    D'Amore's name may not be used to endorse or promote products
*    derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE URBANA-CHAMPAIGN INDEPENDENT
* MEDIA CENTER AND GARRETT D'AMORE ``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 URBANA-CHAMPAIGN INDEPENDENT
* MEDIA CENTER OR GARRETT D'AMORE 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.
*/
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: ar5312_board.c,v 1.5 2015/06/09 22:50:50 matt Exp $");

#include <sys/param.h>
#include <sys/bus.h>
#include <sys/device.h>
#include <sys/systm.h>

#include <mips/cpuregs.h>

#include <mips/atheros/include/ar5312reg.h>
#include <mips/atheros/include/platform.h>

#include <ah_soc.h>

extern const char *ether_sprintf(const uint8_t *);

/*
* Locate the Board Configuration data using heuristics.
* Search backward from the (aliased) end of flash looking
* for the signature string that marks the start of the data.
* We search at most 500KB.
*/
static const struct ar531x_boarddata *
ar5312_get_board_info(void)
{
       static const struct ar531x_boarddata *board = NULL;
       const uint8_t *ptr, *end;
       uint32_t fctl;

       if (board == NULL) {
               /* configure flash bank 0 */
               fctl = REGVAL(AR5312_FLASHCTL_BASE + AR5312_FLASHCTL_0) &
                   AR5312_FLASHCTL_MW;

               fctl |=
                   AR5312_FLASHCTL_E |
                   AR5312_FLASHCTL_RBLE |
                   AR5312_FLASHCTL_AC_8M |
                   __SHIFTIN(1, AR5312_FLASHCTL_IDCY) |
                   __SHIFTIN(7, AR5312_FLASHCTL_WST1) |
                   __SHIFTIN(7, AR5312_FLASHCTL_WST2);

               REGVAL(AR5312_FLASHCTL_BASE + AR5312_FLASHCTL_0) = fctl;

               REGVAL(AR5312_FLASHCTL_BASE + AR5312_FLASHCTL_1) &=
                   ~(AR5312_FLASHCTL_E | AR5312_FLASHCTL_AC);

               REGVAL(AR5312_FLASHCTL_BASE + AR5312_FLASHCTL_2) &=
                   ~(AR5312_FLASHCTL_E | AR5312_FLASHCTL_AC);

               /* search backward in the flash looking for the signature */
               ptr = (const uint8_t *) MIPS_PHYS_TO_KSEG1(AR5312_FLASH_END - 0x1000);
               end = ptr - (500 * 1024);       /* NB: max 500KB window */
               /* XXX validate end */
               for (; ptr > end; ptr -= 0x1000)
                       if (*(const uint32_t *)ptr == AR531X_BD_MAGIC) {
                               board = (const struct ar531x_boarddata *) ptr;
                               break;
                       }
       }
       return board;
}

/*
* Locate the radio configuration data; it is located relative
* to the board configuration data.
*/
static const void *
ar5312_get_radio_info(void)
{
       static const void *radio = NULL;
       const struct ar531x_boarddata *board;
       const uint8_t *baddr, *ptr, *end;

       if (radio == NULL) {
               board = ar5312_get_board_info();
               if (board == NULL)
                       return NULL;
               baddr = (const uint8_t *) board;
               ptr = baddr + 0x1000;
               end = (const uint8_t *)
                   MIPS_PHYS_TO_KSEG1(AR5312_FLASH_END-0x1000);
       again:
               for (; ptr < end; ptr += 0x1000)
                       if (*(const uint32_t *)ptr != 0xffffffff) {
                               radio = ptr;
                               goto done;
                       }
               /* sort of an Algol-style for loop ... */
               if (end == (uint8_t *) MIPS_PHYS_TO_KSEG1(AR5312_FLASH_END)) {
                       /* NB: AR2316 has radio data in a different location */
                       ptr = baddr + 0xf8;
                       end = (const uint8_t *)
                           MIPS_PHYS_TO_KSEG1(AR5312_FLASH_END-0x1000 + 0xf8);
                       goto again;
               }
       }
done:
       return radio;
}

const struct atheros_boardsw ar5312_boardsw = {
       .absw_get_board_info = ar5312_get_board_info,
       .absw_get_radio_info = ar5312_get_radio_info,
};