Skip to content

Group IO transfer code within utility function 'transfer_and_wait'. #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 20, 2021
Merged

Group IO transfer code within utility function 'transfer_and_wait'. #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions examples/Threadsafe_IO/Threadsafe_SPI/Threadsafe_SPI.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,7 @@ byte bmp388_read_reg(byte const reg_addr)
byte read_write_buf[] = {static_cast<byte>(0x80 | reg_addr), 0, 0};

IoRequest req(read_write_buf, sizeof(read_write_buf), nullptr, 0);
IoResponse rsp = bmp388.transfer(req);

/* Do other stuff */

rsp->wait();
IoResponse rsp = transfer_and_wait(bmp388, req);

return read_write_buf[2];
}
Expand Down
12 changes: 6 additions & 6 deletions examples/Threadsafe_IO/Threadsafe_Wire/Threadsafe_Wire.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ void setup()

void loop()
{

/* If we don't hand back control then the main thread
* will hog the CPU and all other thread's won't get
* time to be executed.
*/
rtos::ThisThread::yield();
}

/**************************************************************************************
Expand All @@ -61,11 +65,7 @@ byte lsm6dsox_read_reg(byte const reg_addr)
byte read_buf = 0;

IoRequest req(write_buf, read_buf);
IoResponse rsp = lsm6dsox.transfer(req);

/* Optionally do other stuff */

rsp->wait();
IoResponse rsp = transfer_and_wait(lsm6dsox, req);

return read_buf;
}
Expand Down
1 change: 1 addition & 0 deletions src/Arduino_Threads.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
#include "threading/Shared.hpp"

#include "io/BusDevice.h"
#include "io/util/util.h"
#include "io/spi/SpiBusDevice.h"
#include "io/wire/WireBusDevice.h"
#include "io/serial/SerialDispatcher.h"
Expand Down
34 changes: 34 additions & 0 deletions src/io/util/util.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* This file is part of the Arduino_ThreadsafeIO library.
* Copyright (c) 2021 Arduino SA.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/

/**************************************************************************************
* INCLUDE
**************************************************************************************/

#include "util.h"

/**************************************************************************************
* FUNCTION DEFINITION
**************************************************************************************/

IoResponse transfer_and_wait(BusDevice & dev, IoRequest & req)
{
IoResponse rsp = dev.transfer(req);
rsp->wait();
return rsp;
}
35 changes: 35 additions & 0 deletions src/io/util/util.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*
* This file is part of the Arduino_ThreadsafeIO library.
* Copyright (c) 2021 Arduino SA.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/

#ifndef ARDUINO_THREADS_UTIL_H_
#define ARDUINO_THREADS_UTIL_H_

/**************************************************************************************
* INCLUDE
**************************************************************************************/

#include "../BusDevice.h"
#include "../IoTransaction.h"

/**************************************************************************************
* FUNCTION DECLARATION
**************************************************************************************/

IoResponse transfer_and_wait(BusDevice & dev, IoRequest & req);

#endif /* ARDUINO_THREADS_UTIL_H_ */