wg_eeprom.h
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2008, Willow Garage, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of the Willow Garage nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *********************************************************************/
34 
35 #pragma once
36 
39 #include <stdint.h>
40 #include <boost/thread/mutex.hpp>
41 
42 namespace ethercat_hardware
43 {
44 
45 struct EepromStatusReg;
46 struct WG0XSpiEepromCmd;
47 
48 class WGEeprom
49 {
50 public:
51  WGEeprom();
52  bool readEepromPage(EthercatCom *com, WGMailbox *mbx, unsigned page, void* data, unsigned length);
53  bool writeEepromPage(EthercatCom *com, WGMailbox *mbx, unsigned page, const void* data, unsigned length);
54 
55 protected:
56  static const unsigned NUM_EEPROM_PAGES = 4096;
57  static const unsigned MAX_EEPROM_PAGE_SIZE = 264;
58 
59  // SPI Eeprom State machine helper functions
61  bool sendSpiEepromCmd(EthercatCom *com, WGMailbox *mbx, const WG0XSpiEepromCmd &cmd);
63 
64  // Eeprom helper functions
66  bool waitForEepromReady(EthercatCom *com, WGMailbox *mbx);
67 
69  boost::mutex mutex_;
70 };
71 
72 
73 }; //end namespace ethercat_hardware
bool waitForEepromReady(EthercatCom *com, WGMailbox *mbx)
Waits for EEPROM to become ready.
Definition: wg_eeprom.cpp:359
boost::mutex mutex_
Only one eeprom transaction can occur at a time.
Definition: wg_eeprom.h:69
uint16_t length
Definition: wg_util.h:119
bool sendSpiEepromCmd(EthercatCom *com, WGMailbox *mbx, const WG0XSpiEepromCmd &cmd)
Sends command to SPI EEPROM state machine.
Definition: wg_eeprom.cpp:158
static const unsigned NUM_EEPROM_PAGES
Definition: wg_eeprom.h:56
bool readSpiEepromCmd(EthercatCom *com, WGMailbox *mbx, WG0XSpiEepromCmd &cmd)
Reads SPI state machine command register.
Definition: wg_eeprom.cpp:456
data
bool writeEepromPage(EthercatCom *com, WGMailbox *mbx, unsigned page, const void *data, unsigned length)
Write data to single eeprom page.
Definition: wg_eeprom.cpp:289
bool readEepromPage(EthercatCom *com, WGMailbox *mbx, unsigned page, void *data, unsigned length)
Read data from single eeprom page.
Definition: wg_eeprom.cpp:223
static const unsigned MAX_EEPROM_PAGE_SIZE
Definition: wg_eeprom.h:57
bool readEepromStatusReg(EthercatCom *com, WGMailbox *mbx, EepromStatusReg &reg)
Reads EEPROM status register.
Definition: wg_eeprom.cpp:401
bool waitForSpiEepromReady(EthercatCom *com, WGMailbox *mbx)
Waits for SPI eeprom state machine to be idle.
Definition: wg_eeprom.cpp:121


ethercat_hardware
Author(s): Rob Wheeler , Derek King
autogenerated on Tue Mar 28 2023 02:10:20