qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Qemu-devel] [PATCH] memory: update comments and fix some typos


From: Zhoujian (jay)
Subject: Re: [Qemu-devel] [PATCH] memory: update comments and fix some typos
Date: Wed, 17 Jan 2018 01:16:07 +0000

> -----Original Message-----
> From: Paolo Bonzini [mailto:address@hidden
> Sent: Tuesday, January 16, 2018 10:44 PM
> To: Zhoujian (jay) <address@hidden>; address@hidden
> Cc: Huangweidong (C) <address@hidden>; wangxin (U)
> <address@hidden>
> Subject: Re: [PATCH] memory: update comments and fix some typos
> 
> On 16/01/2018 09:32, Zhoujian (jay) wrote:
> > Hi Paolo,
> > Maybe it is a little boring to review updated comments, but I think it
> > is the right thing to do, so could you have a look when you're free?
> 
> On the contrary, it's useful!  I just missed it among the email after new
> year's break.
> 
> I queued it now.

Thanks,

Jay

> 
> Paolo
> 
> > Regards,
> > Jay
> >
> >> -----Original Message-----
> >> From: Zhoujian (jay)
> >> Sent: Thursday, January 04, 2018 1:30 PM
> >> To: address@hidden
> >> Cc: address@hidden; Huangweidong (C) <address@hidden>;
> >> wangxin
> >> (U) <address@hidden>; Zhoujian (jay)
> >> <address@hidden>
> >> Subject: [PATCH] memory: update comments and fix some typos
> >>
> >> Signed-off-by: Jay Zhou <address@hidden>
> >> ---
> >>  include/exec/memory.h | 27 +++++++++++++++------------
> >>  1 file changed, 15 insertions(+), 12 deletions(-)
> >>
> >> diff --git a/include/exec/memory.h b/include/exec/memory.h index
> >> a4cabdf..6e5684d 100644
> >> --- a/include/exec/memory.h
> >> +++ b/include/exec/memory.h
> >> @@ -324,7 +324,7 @@ FlatView *address_space_to_flatview(AddressSpace *as);
> >>   * MemoryRegionSection: describes a fragment of a #MemoryRegion
> >>   *
> >>   * @mr: the region, or %NULL if empty
> >> - * @address_space: the address space the region is mapped in
> >> + * @fv: the flat view of the address space the region is mapped in
> >>   * @offset_within_region: the beginning of the section, relative to
> >> @mr's start
> >>   * @size: the size of the section; will not exceed @mr's boundaries
> >>   * @offset_within_address_space: the address of the first byte of
> >> the section @@ -607,6 +607,7 @@ void
> >> memory_region_init_rom_nomigrate(MemoryRegion *mr,
> >>   * @mr: the #MemoryRegion to be initialized.
> >>   * @owner: the object that tracks the region's reference count
> >>   * @ops: callbacks for write access handling (must not be NULL).
> >> + * @opaque: passed to the read and write callbacks of the @ops structure.
> >>   * @name: Region name, becomes part of RAMBlock name used in
> >> migration stream
> >>   *        must be unique within any device
> >>   * @size: size of the region.
> >> @@ -650,11 +651,10 @@ static inline void
> >> memory_region_init_reservation(MemoryRegion *mr,
> >>   * An IOMMU region translates addresses and forwards accesses to a target
> >>   * memory region.
> >>   *
> >> - * @typename: QOM class name
> >>   * @_iommu_mr: the #IOMMUMemoryRegion to be initialized
> >>   * @instance_size: the IOMMUMemoryRegion subclass instance size
> >> + * @mrtypename: the type name of the #IOMMUMemoryRegion
> >>   * @owner: the object that tracks the region's reference count
> >> - * @ops: a function that translates addresses into the @target region
> >>   * @name: used for debugging; not visible to the user or ABI
> >>   * @size: size of the region.
> >>   */
> >> @@ -824,8 +824,8 @@ static inline IOMMUMemoryRegion
> >> *memory_region_get_iommu(MemoryRegion *mr)
> >>   * memory_region_get_iommu_class_nocheck: returns iommu memory region
> class
> >>   *   if an iommu or NULL if not
> >>   *
> >> - * Returns pointer to IOMMUMemoryRegioniClass if a memory region is
> >> an iommu,
> >> - * otherwise NULL. This is fast path avoinding QOM checking, use
> >> with caution.
> >> + * Returns pointer to IOMMUMemoryRegionClass if a memory region is
> >> + an iommu,
> >> + * otherwise NULL. This is fast path avoiding QOM checking, use with
> caution.
> >>   *
> >>   * @mr: the memory region being queried
> >>   */
> >> @@ -990,7 +990,8 @@ int memory_region_get_fd(MemoryRegion *mr);
> >>   * protecting the pointer, such as a reference to the region that
> includes
> >>   * the incoming ram_addr_t.
> >>   *
> >> - * @mr: the memory region being queried.
> >> + * @ptr: the host pointer to be converted
> >> + * @offset: the offset within memory region
> >>   */
> >>  MemoryRegion *memory_region_from_host(void *ptr, ram_addr_t
> >> *offset);
> >>
> >> @@ -1267,7 +1268,7 @@ void
> >> memory_region_clear_global_locking(MemoryRegion
> >> *mr);
> >>   * @size: the size of the access to trigger the eventfd
> >>   * @match_data: whether to match against @data, instead of just @addr
> >>   * @data: the data to match against the guest write
> >> - * @fd: the eventfd to be triggered when @addr, @size, and @data all
> match.
> >> + * @e: event notifier to be triggered when @addr, @size, and @data all
> match.
> >>   **/
> >>  void memory_region_add_eventfd(MemoryRegion *mr,
> >>                                 hwaddr addr, @@ -1287,7 +1288,7 @@
> >> void memory_region_add_eventfd(MemoryRegion *mr,
> >>   * @size: the size of the access to trigger the eventfd
> >>   * @match_data: whether to match against @data, instead of just @addr
> >>   * @data: the data to match against the guest write
> >> - * @fd: the eventfd to be triggered when @addr, @size, and @data all
> match.
> >> + * @e: event notifier to be triggered when @addr, @size, and @data all
> match.
> >>   */
> >>  void memory_region_del_eventfd(MemoryRegion *mr,
> >>                                 hwaddr addr, @@ -1523,7 +1524,7 @@
> >> bool memory_region_request_mmio_ptr(MemoryRegion *mr, hwaddr addr);
> >>   * will need to request the pointer again.
> >>   *
> >>   * @mr: #MemoryRegion associated to the pointer.
> >> - * @addr: address within that region
> >> + * @offset: offset within the memory region
> >>   * @size: size of that area.
> >>   */
> >>  void memory_region_invalidate_mmio_ptr(MemoryRegion *mr, hwaddr
> >> offset, @@ -
> >> 1592,6 +1593,7 @@ void address_space_destroy(AddressSpace *as);
> >>   * @addr: address within that address space
> >>   * @attrs: memory transaction attributes
> >>   * @buf: buffer with the data transferred
> >> + * @len: the number of bytes to read or write
> >>   * @is_write: indicates the transfer direction
> >>   */
> >>  MemTxResult address_space_rw(AddressSpace *as, hwaddr addr, @@
> >> -1609,6
> >> +1611,7 @@ MemTxResult address_space_rw(AddressSpace *as, hwaddr
> >> +addr,
> >>   * @addr: address within that address space
> >>   * @attrs: memory transaction attributes
> >>   * @buf: buffer with the data transferred
> >> + * @len: the number of bytes to write
> >>   */
> >>  MemTxResult address_space_write(AddressSpace *as, hwaddr addr,
> >>                                  MemTxAttrs attrs, @@ -1807,7 +1810,7
> >> @@ IOMMUTLBEntry address_space_get_iotlb_entry(AddressSpace *as, hwaddr
> addr,
> >>   * called from an RCU critical section, to avoid that the last reference
> >>   * to the returned region disappears after address_space_translate
> returns.
> >>   *
> >> - * @as: #AddressSpace to be accessed
> >> + * @fv: #FlatView to be accessed
> >>   * @addr: address within that address space
> >>   * @xlat: pointer to address within the returned memory region section's
> >>   * #MemoryRegion.
> >> @@ -1865,7 +1868,7 @@ void *address_space_map(AddressSpace *as, hwaddr
> addr,
> >>   * the amount of memory that was actually read or written by the caller.
> >>   *
> >>   * @as: #AddressSpace used
> >> - * @addr: address within that address space
> >> + * @buffer: host pointer as returned by address_space_map()
> >>   * @len: buffer length as returned by address_space_map()
> >>   * @access_len: amount of data actually transferred
> >>   * @is_write: indicates the transfer direction @@ -1902,7 +1905,7 @@
> >> static inline bool memory_access_is_direct(MemoryRegion *mr, bool is_write)
> >>   * or failed (eg unassigned memory, device rejected the transaction,
> >>   * IOMMU fault).
> >>   *
> >> - * @as: #AddressSpace to be accessed
> >> + * @fv: #FlatView to be accessed
> >>   * @addr: address within that address space
> >>   * @attrs: memory transaction attributes
> >>   * @buf: buffer with the data transferred
> >> --
> >> 1.8.3.1
> >>
> >


reply via email to

[Prev in Thread] Current Thread [Next in Thread]