owibus.h

Go to the documentation of this file.

#ifndef _OWIBUS_H_
#define _OWIBUS_H_

/*
 * Copyright (C) 2012 by Uwe Bonnes(bon@elektron.ikp.physik.tu-darmstadt.de)
 *
 * 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 holders nor the names of
 *    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 OWNER 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.
 *
 * For additional information see http://www.ethernut.de/
 */

#include <cfg/arch.h>
#include <stdint.h>


/* Overdrive Commands as in
 * http://www.ovro.caltech.edu/~dwh/correlator/pdf/onewire.pdf
 */
#define OWI_READ_ROM            0x33    
#define OWI_OVERDRIVE_SKIP_ROM  0x3c    
#define OWI_CONVERT_T           0x44    
#define OWI_MATCH_ROM           0x55    
#define OWI_OVERDRIVE_MATCH_ROM 0x69    
#define OWI_SKIP_ROM            0xCC    
#define OWI_READ                0xBE    
#define OWI_SEARCH_ROM          0xF0    
#define OWI_LAST_DEVICE     0x00        
#define OWI_SEARCH_FIRST    0xFF        
enum OWI_ERRORS {
    OWI_SUCCESS = 0,            
    OWI_PRESENCE_ERR = -1,      
    OWI_INVALID_HW = -2,        
    OWI_OUT_OF_MEM = -3,        
    OWI_HW_ERROR = -4,          
    OWI_DATA_ERROR = -5,        
    OWI_NOT_IMPLEMENTED = -6,   
};

enum OWIBUS_MODE {
    OWI_MODE_NORMAL = 0,        
    OWI_MODE_OVERDRIVE = 1,     
    OWI_MODE_NONE = 2,          
};

enum STM32_OWITIMER_COMMANDS {
    OWI_CMD_RESET = 0,          
    OWI_CMD_RWBIT = 1,          
    OWI_CMD_NONE = 2,           
};

enum STM32_OWITIMER_PHASES {
    OWI_PHASE_SETUP = 0,        
    OWI_PHASE_SYNC_PULSE = 1,   
    OWI_PHASE_RW = 2,           
    OWI_PHASE_RELEASE = 3,      
    OWI_PHASE_NONE = 4,         
};

#define OWI_OVERDRIVE 0x1       
#define OWI_PULLUP    0x2       
typedef struct _NUTOWIBUS NUTOWIBUS;

#include "owibus_bbif.h"
#include "owibus_uartif.h"

/* Include possible architecture specific OWI implementation here. */
#if defined(MCU_STM32)
#endif

struct _NUTOWIBUS {
    uintptr_t owibus_info;
    uint32_t mode;
    int(*OwiTouchReset) (NUTOWIBUS *);
    int(*OwiReadBlock) (NUTOWIBUS *bus, uint8_t *data, uint_fast8_t);
    int(*OwiWriteBlock) (NUTOWIBUS *bus, uint8_t *data, uint_fast8_t);
};

int OwiRomSearch(NUTOWIBUS *bus, uint8_t *diff, uint64_t *hid);
int OwiCommand(NUTOWIBUS *bus, uint8_t cmd, uint64_t *hid);
int OwiReadBlock(NUTOWIBUS *bus, uint8_t *data, uint_fast8_t len);
int OwiWriteBlock(NUTOWIBUS *bus, uint8_t *data, uint_fast8_t len);
int OwiSetMode(NUTOWIBUS *bus, uint_fast8_t mode);
int OwiGetMode(NUTOWIBUS *bus);

#endif