Skip to content
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.

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

Fix various typos #189

Merged
merged 1 commit into from
Jan 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/actions/build_ci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This action test builds for a specified target.
### `target`

**Required** the build target. Default `"linux"`.
The supported taget are:
The supported targets are:
linux
generic arm
freertos
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ own project.

* **WITH_DOC** (default ON): Build with documentation. Add -DWITH_DOC=OFF in
cmake command line to disable.
* **WITH_EXAMPLES** (default ON): Build with application exemples. Add
* **WITH_EXAMPLES** (default ON): Build with application examples. Add
-DWITH_DOC=OFF in cmake command line to disable the option.
* **WITH_TESTS** (default ON): Build with application tests. Add -DWITH_DOC=OFF
in cmake command line to disable the option.
Expand Down Expand Up @@ -231,7 +231,7 @@ handler registered by the user application.
libmetal provides APIs to flush and invalidate caches.

The cache APIs for Linux userspace are empty functions for now as cache
operations system calls are not avaiable for all architectures.
operations system calls are not available for all architectures.

### DMA

Expand Down
2 changes: 1 addition & 1 deletion cmake/platforms/template-freertos.cmake
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Modify to match your needs. These setttings can also be overridden at the
# Modify to match your needs. These settings can also be overridden at the
# command line. (eg. cmake -DCMAKE_C_FLAGS="-O3")

set (CMAKE_SYSTEM_PROCESSOR "arm" CACHE STRING "")
Expand Down
2 changes: 1 addition & 1 deletion cmake/platforms/template-generic.cmake
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Modify to match your needs. These setttings can also be overridden at the
# Modify to match your needs. These settings can also be overridden at the
# command line. (eg. cmake -DCMAKE_C_FLAGS="-O3")

set (CMAKE_SYSTEM_PROCESSOR "arm" CACHE STRING "")
Expand Down
2 changes: 1 addition & 1 deletion cmake/platforms/zynqmp-r5-generic.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ set (CMAKE_SYSTEM_PROCESSOR "arm" CACHE STRING "")
set (MACHINE "zynqmp_r5" CACHE STRING "")
set (CROSS_PREFIX "armr5-none-eabi-" CACHE STRING "")

# Xilinx SDK version earlier than 2017.2 use mfloat-abi=soft by default to generat libxil
# Xilinx SDK version earlier than 2017.2 use mfloat-abi=soft by default to generate libxil
set (CMAKE_C_FLAGS "-mfloat-abi=hard -mfpu=vfpv3-d16 -mcpu=cortex-r5" CACHE STRING "")

include (cross-generic-gcc)
Expand Down
4 changes: 2 additions & 2 deletions examples/system/freertos/zynqmp_r5/zynqmp_amp_demo/common.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
#define IPI_ISR_OFFSET 0x10 /* IPI interrupt status reg offset */
#define IPI_IMR_OFFSET 0x14 /* IPI interrupt mask reg offset */
#define IPI_IER_OFFSET 0x18 /* IPI interrupt enable reg offset */
#define IPI_IDR_OFFSET 0x1C /* IPI interrup disable reg offset */
#define IPI_IDR_OFFSET 0x1C /* IPI interrupt disable reg offset */

#define IPI_MASK 0x1000000 /* IPI mask for kick from APU.
We use PL0 IPI in this demo. */
Expand Down Expand Up @@ -139,7 +139,7 @@ static inline void wait_for_interrupt()
}

/**
* @breif wait_for_notified() - Loop until notified bit
* @brief wait_for_notified() - Loop until notified bit
* in channel is set.
*
* @param[in] notified - pointer to the notified variable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/*****************************************************************************
* ipi_latency_demod.c
* This is the remote side of the IPI latency measurement demo.
* This demo does the follwing steps:
* This demo does the following steps:
*
* 1. Open the shared memory device.
* 1. Open the TTC timer device.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/*****************************************************************************
* shmem_latency_demod.c
* This is the remote side of the IPI latency measurement demo.
* This demo does the follwing steps:
* This demo does the following steps:
*
* 1. Get the shared memory device libmetal I/O region.
* 1. Get the TTC timer device libemtal I/O region.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* 6. Download throughput measurement:
* Start TTC RPU counter, wait for IPI kick, check if data is available,
* if yes, read as much data as possible from shared memory. It will
* iterates untill 1000 packages have been received, stop TTC RPU counter
* iterates until 1000 packages have been received, stop TTC RPU counter
* and kick IPI to notify the remote. Repeat for different package size.
* 7. Upload throughput measurement:
* Start TTC RPU counter, write data to shared memory and kick IPI to
Expand Down Expand Up @@ -144,7 +144,7 @@ static int ipi_irq_handler (int vect_id, void *priv)
* - Download throughput measurement:
* Start TTC RPU counter, wait for IPI kick, check if data is
* available, if yes, read as much data as possible from shared
* memory. It will iterates untill 1000 packages have been received,
* memory. It will iterates until 1000 packages have been received,
* stop TTC RPU counter and kick IPI to notify the remote. Repeat
* for different package size.
* - Upload throughput measurement:
Expand Down
4 changes: 2 additions & 2 deletions examples/system/generic/zynqmp_r5/zynqmp_amp_demo/common.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
#define IPI_ISR_OFFSET 0x10 /* IPI interrupt status reg offset */
#define IPI_IMR_OFFSET 0x14 /* IPI interrupt mask reg offset */
#define IPI_IER_OFFSET 0x18 /* IPI interrupt enable reg offset */
#define IPI_IDR_OFFSET 0x1C /* IPI interrup disable reg offset */
#define IPI_IDR_OFFSET 0x1C /* IPI interrupt disable reg offset */

#define IPI_MASK 0x1000000 /* IPI mask for kick from APU.
We use PL0 IPI in this demo. */
Expand Down Expand Up @@ -140,7 +140,7 @@ static inline void wait_for_interrupt()
}

/**
* @breif wait_for_notified() - Loop until notified bit
* @brief wait_for_notified() - Loop until notified bit
* in channel is set.
*
* @param[in] notified - pointer to the notified variable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/*****************************************************************************
* ipi_latency_demod.c
* This is the remote side of the IPI latency measurement demo.
* This demo does the follwing steps:
* This demo does the following steps:
*
* 1. Open the shared memory device.
* 1. Open the TTC timer device.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* 1. Initialize the platform hardware such as UART, GIC.
* 2. Connect the IPI interrupt.
* 3. Register IPI device, shared memory descriptor device and shared memory
* device with libmetal in the intialization.
* device with libmetal in the initialization.
* 4. In the main application it does the following,
* * open the registered libmetal devices: IPI device, shared memory
* descriptor device and shared memory device.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/*****************************************************************************
* shmem_latency_demod.c
* This is the remote side of the IPI latency measurement demo.
* This demo does the follwing steps:
* This demo does the following steps:
*
* 1. Get the shared memory device libmetal I/O region.
* 1. Get the TTC timer device libemtal I/O region.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* 6. Download throughput measurement:
* Start TTC RPU counter, wait for IPI kick, check if data is available,
* if yes, read as much data as possible from shared memory. It will
* iterates untill 1000 packages have been received, stop TTC RPU counter
* iterates until 1000 packages have been received, stop TTC RPU counter
* and kick IPI to notify the remote. Repeat for different package size.
* 7. Upload throughput measurement:
* Start TTC RPU counter, write data to shared memory and kick IPI to
Expand Down Expand Up @@ -144,7 +144,7 @@ static int ipi_irq_handler (int vect_id, void *priv)
* - Download throughput measurement:
* Start TTC RPU counter, wait for IPI kick, check if data is
* available, if yes, read as much data as possible from shared
* memory. It will iterates untill 1000 packages have been received,
* memory. It will iterates until 1000 packages have been received,
* stop TTC RPU counter and kick IPI to notify the remote. Repeat
* for different package size.
* - Upload throughput measurement:
Expand Down
6 changes: 3 additions & 3 deletions examples/system/linux/zynqmp/zynqmp_amp_demo/common.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
#define IPI_ISR_OFFSET 0x10 /* IPI interrupt status reg offset */
#define IPI_IMR_OFFSET 0x14 /* IPI interrupt mask reg offset */
#define IPI_IER_OFFSET 0x18 /* IPI interrupt enable reg offset */
#define IPI_IDR_OFFSET 0x1C /* IPI interrup disable reg offset */
#define IPI_IDR_OFFSET 0x1C /* IPI interrupt disable reg offset */

#define IPI_MASK 0x100 /* IPI mask for kick from RPU. */

Expand Down Expand Up @@ -146,7 +146,7 @@ int shmem_latency_demo();
int shmem_throughput_demo();

/**
* @breif wait_for_notified() - Loop until notified bit in channel is set.
* @brief wait_for_notified() - Loop until notified bit in channel is set.
*
* @param[in] notified - pointer to the notified variable
*/
Expand All @@ -167,7 +167,7 @@ static inline void wait_for_notified(atomic_int *notified)
}

/**
* @breif dump_buffer() - print hex value of each byte in the buffer
* @brief dump_buffer() - print hex value of each byte in the buffer
*
* @param[in] buf - pointer to the buffer
* @param[in] len - len of the buffer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/*****************************************************************************
* ipi_latency_demo.c
* This demo measures the IPI latency between the APU and RPU.
* This demo does the follwing steps:
* This demo does the following steps:
*
* 1. Get the shared memory device I/O region.
* 1. Get the TTC timer device I/O region.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ static atomic_int remote_nkicked; /* is remote kicked, 0 - kicked,
1 - not-kicked */

/**
* @breif get_timestamp() - Get the timestamp
* @brief get_timestamp() - Get the timestamp
* IT gets the timestamp and return nanoseconds.
*
* @return nano seconds.
Expand Down
2 changes: 1 addition & 1 deletion examples/system/linux/zynqmp/zynqmp_amp_demo/shmem_demo.c
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ struct msg_hdr_s {
* If messages differ, report error.
*
* Steps:
* 1. Clear demo control and TX/RX avaiable values
* 1. Clear demo control and TX/RX available values
*
* @param[in] shm_io - metal i/o region of the shared memory
* @return - return 0 on success, otherwise return error number indicating
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* 7. Download throughput measurement:
* Start TTC APU counter, wait for IPI kick, check if data is available,
* if yes, read as much data as possible from shared memory. It will
* iterates untill 1000 packages have been received, stop TTC APU counter.
* iterates until 1000 packages have been received, stop TTC APU counter.
* Wait for RPU IPI kick so that APU can get the TTC RPU TX counter
* value. Kick IPI to notify the remote it has read the TTCi counter.
* Repeat for different package size.
Expand Down Expand Up @@ -182,7 +182,7 @@ static int ipi_irq_handler (int vect_id, void *priv)
* - Download throughput measurement:
* Start TTC APU counter, wait for IPI kick, check if data is
* available, if yes, read as much data as possible from shared
* memory. It will iterates untill 1000 packages have been received,
* memory. It will iterates until 1000 packages have been received,
* stop TTC APU counter. Wait for RPU IPI kick so that APU can get
* the TTC RPU TX counter value. Kick IPI to notify the remote it
* has read the TTCi counter. Repeat for different package size.
Expand Down
2 changes: 1 addition & 1 deletion lib/compiler.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#elif defined(__ICCARM__)
# include <metal/compiler/iar/compiler.h>
#elif defined(__CC_ARM)
# error "MDK-ARM ARMCC compiler requires the GNU extentions to work correctly"
# error "MDK-ARM ARMCC compiler requires the GNU extensions to work correctly"
#else
# error "Missing compiler support"
#endif
Expand Down
2 changes: 1 addition & 1 deletion lib/irq_controller.h
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ struct metal_irq_controller {
*/
int irq_num; /**< Number of IRQs managed by the IRQ controller */
void *arg; /**< Argument to pass to interrupt controller function */
metal_irq_set_enable irq_set_enable; /**< function to set IRQ eanble */
metal_irq_set_enable irq_set_enable; /**< function to set IRQ enable */
metal_cntr_irq_register irq_register; /**< function to register IRQ
* handler
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/list.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ struct metal_list {
};

/*
* METAL_INIT_LIST - used for initializing an list elmenet in a static struct
* METAL_INIT_LIST - used for initializing an list element in a static struct
* or global
*/
#define METAL_INIT_LIST(name) { .next = &name, .prev = &name }
Expand Down
2 changes: 1 addition & 1 deletion lib/log.h
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ extern enum metal_log_level metal_get_log_level(void);

/**
* @brief Default libmetal log handler. This handler prints libmetal log
* mesages to stderr.
* messages to stderr.
* @param[in] level log message level.
* @param[in] format log message format string.
* @return 0 on success, or -errno on failure.
Expand Down
2 changes: 1 addition & 1 deletion lib/processor/aarch64/cpu.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

/*
* @file cpu.h
* @brief CPU specific primatives
* @brief CPU specific primitives
*/

#ifndef __METAL_AARCH64_CPU__H__
Expand Down
2 changes: 1 addition & 1 deletion lib/processor/arm/cpu.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

/*
* @file cpu.h
* @brief CPU specific primatives
* @brief CPU specific primitives
*/

#ifndef __METAL_ARM_CPU__H__
Expand Down
2 changes: 1 addition & 1 deletion lib/processor/microblaze/cpu.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

/*
* @file cpu.h
* @brief CPU specific primatives on microblaze platform.
* @brief CPU specific primitives on microblaze platform.
*/

#ifndef __METAL_MICROBLAZE__H__
Expand Down
2 changes: 1 addition & 1 deletion lib/processor/x86/cpu.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

/*
* @file cpu.h
* @brief CPU specific primatives
* @brief CPU specific primitives
*/

#ifndef __METAL_X86_CPU__H__
Expand Down
2 changes: 1 addition & 1 deletion lib/processor/x86_64/cpu.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

/*
* @file cpu.h
* @brief CPU specific primatives
* @brief CPU specific primitives
*/

#ifndef __METAL_X86_64_CPU__H__
Expand Down
2 changes: 1 addition & 1 deletion lib/processor/xtensa/cpu.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

/*
* @file cpu.h
* @brief CPU specific primatives
* @brief CPU specific primitives
*/

#ifndef __METAL_XTENSA_CPU__H__
Expand Down
2 changes: 1 addition & 1 deletion lib/system/freertos/zynqmp_a53/sys.c
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ void *metal_machine_io_mem_map(void *va, metal_phys_addr_t pa,
if (!flags)
return va;

/* Ensure alignement on a section boundary */
/* Ensure alignment on a section boundary */
pa &= ~(ttb_size-1UL);

/*
Expand Down
2 changes: 1 addition & 1 deletion lib/system/generic/zynqmp_a53/sys.c
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ void *metal_machine_io_mem_map(void *va, metal_phys_addr_t pa,
if (!flags)
return va;

/* Ensure alignement on a section boundary */
/* Ensure alignment on a section boundary */
pa &= ~(ttb_size-1UL);

/*
Expand Down
2 changes: 1 addition & 1 deletion lib/system/linux/mutex.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ typedef struct {
} metal_mutex_t;

/*
* METAL_MUTEX_INIT - used for initializing an mutex elmenet in a static struct
* METAL_MUTEX_INIT - used for initializing an mutex element in a static struct
* or global
*/
#define METAL_MUTEX_INIT(m) { ATOMIC_VAR_INIT(0) }
Expand Down
2 changes: 1 addition & 1 deletion lib/system/nuttx/mutex.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ extern "C" {
typedef mutex_t metal_mutex_t;

/*
* METAL_MUTEX_INIT - used for initializing an mutex elmenet in a static struct
* METAL_MUTEX_INIT - used for initializing an mutex element in a static struct
* or global
*/
#define METAL_MUTEX_INIT(m) MUTEX_INITIALIZER
Expand Down
2 changes: 1 addition & 1 deletion lib/system/zephyr/mutex.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ extern "C" {
typedef struct k_sem metal_mutex_t;

/*
* METAL_MUTEX_INIT - used for initializing an mutex elmenet in a static struct
* METAL_MUTEX_INIT - used for initializing an mutex element in a static struct
* or global
*/
#define METAL_MUTEX_INIT(m) _K_SEM_INITIALIZER(m, 1, 1)
Expand Down
6 changes: 3 additions & 3 deletions scripts/checkpatch.pl
Original file line number Diff line number Diff line change
Expand Up @@ -1188,7 +1188,7 @@ sub sanitise_line {
for ($off = 1; $off < length($line); $off++) {
$c = substr($line, $off, 1);

# Comments we are wacking completly including the begin
# Comments we are wacking completely including the begin
# and end, all to $;.
if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
$sanitise_quote = '*/';
Expand Down Expand Up @@ -4413,7 +4413,7 @@ sub process {
## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
##
## # Remove any bracketed sections to ensure we do not
## # falsly report the parameters of functions.
## # falsely report the parameters of functions.
## my $ln = $line;
## while ($ln =~ s/\([^\(\)]*\)//g) {
## }
Expand Down Expand Up @@ -4904,7 +4904,7 @@ sub process {
{
}

# Flatten any obvious string concatentation.
# Flatten any obvious string concatenation.
while ($dstat =~ s/($String)\s*$Ident/$1/ ||
$dstat =~ s/$Ident\s*($String)/$1/)
{
Expand Down
Loading